The fsharp.openapi from akhansari

fsharp.openapi's Introduction

FSharp OpenAPI

Describe API specifications with computation expressions.
Provide helpers for F# libraries to write specifications and exposing them to Swagger UI.

This is still a work in progress project and breaking changes could be frequent.
Contributions are welcome.

Example Usage

Creating an OpenAPI document

let document =
    apiDocument {
        info (apiInfo {
            version "1.0.0"
            title "Swagger Petstore (Simple)"
        })
        servers [
            apiServer {
                url "http://petstore.swagger.io/api"
            }
        ]
        paths [
            "/pets", apiPathItem {
                operations [
                    OperationType.Get, apiOperation {
                        description "Returns all pets from the system that the user has access to"
                        responses [
                            HttpStatusCode.OK, apiResponse {
                                description "OK"
                            }
                        ]
                    }
                ]
            }
        ]
    }

let outputString =
    document.Serialize (OpenApiSpecVersion.OpenApi3_0, OpenApiFormat.Json)

fsharp.openapi's People

Contributors

Stargazers

Watchers

fsharp.openapi's Issues

Make public nuget package

hello, you have a chance to make this a public nuget? (even in pre-release...)

Required properties ar not aded.

I have the following code

        let schema = apiSchema{
                                required ["api"]
                                title "CreditData"
                                properties [
                                    "api",apiSchema{schemaType "string"}
                                    "credit",
                                        apiSchema{
                                            schemaType "integer" 
                                            minimum 0
                                            
                                        }
                                ]
                              
                            }

But no matter what I do the required prop , "api" is not added to the required props if I use CE syntax but only works if I add the schema manually. Is this a bug or I am doing something wrong?