Spec (Falco.UnionRoutes)

Spec Module

Namespace: Falco.UnionRoutes
Assembly: Falco.UnionRoutes.dll

Generates OpenAPI 3.0 JSON specifications from route union types.

Uses reflection to enumerate all routes and build a complete OpenAPI 3.0 spec. Route paths, HTTP methods, path/query parameters, request bodies, and response types are all derived from the route union structure.

Example

 let spec = Spec.generate<Route> { Title = "My API"; Version = "1.0.0"; Description = None }

val spec: obj

union case Option.None: Option<'T>

Functions and values

Function or value Description

Function or value	Description
`Spec.generate config` Full Usage: `Spec.generate config` Parameters: config : `OpenApiConfig` - OpenAPI metadata (title, version, description). Returns: `string` A JSON string containing the OpenAPI 3.0 specification.	Generates an OpenAPI 3.0 JSON specification from a route union type. config : `OpenApiConfig` OpenAPI metadata (title, version, description). Returns: `string` A JSON string containing the OpenAPI 3.0 specification. Example `let spec = Spec.generate<Route> { Title = "My API"; Version = "1.0.0"; Description = None } printfn "%s" spec` val spec: string union case Option.None: Option<'T> val printfn: format: Printf.TextWriterFormat<'T> -> 'T


                
                  
                    
                      Spec.generate config

Full Usage: Spec.generate config

Parameters:

config : OpenApiConfig - OpenAPI metadata (title, version, description).

Returns: string A JSON string containing the OpenAPI 3.0 specification.

Generates an OpenAPI 3.0 JSON specification from a route union type.

config : OpenApiConfig: OpenAPI metadata (title, version, description).

Returns: string: A JSON string containing the OpenAPI 3.0 specification.

Example

 let spec = Spec.generate<Route> { Title = "My API"; Version = "1.0.0"; Description = None }
 printfn "%s" spec

val spec: string

union case Option.None: Option<'T>

val printfn: format: Printf.TextWriterFormat<'T> -> 'T