Oxpecker.OpenApi 0.1.1

Oxpecker.OpenApi

Oxpecker.OpenApi 通过代码自动生成 OpenApi spec 功能扩展了 Oxpecker 框架。

NuGet 包

两种用法

open Oxpecker
open Oxpecker.OpenApi

let endpoints = [
    // addOpenApi supports passing detailed configuration
    POST [
        route "/product" (text "Product posted!")
            |> addOpenApi (OpenApiConfig(
                requestBody = RequestBody(typeof<Product>),
                responseBodies = [| ResponseBody(typeof<string>) |],
                configureOperation = (fun o -> o.OperationId <- "PostProduct"; o)
            ))
    ]
    // addOpenApiSimple is a shortcut for simple cases
    GET [
        routef "/product/{%i}" (
            fun id ->
                forecases
                |> Array.find (fun f -> f.Id = num)
                |> json
        )
            |> configureEndpoint _.WithName("GetProduct")
            |> addOpenApiSimple<int, Product>
    ]
]

文档

集成

由于 Oxpecker.OpenApi 在 Microsoft.AspNetCore.OpenApi 和 Swashbuckle.AspNetCore 包的顶部运行，因此您需要执行 标准步骤

let configureApp (appBuilder: IApplicationBuilder) =
    appBuilder
        .UseRouting()
        .Use(errorHandler)
        .UseOxpecker(endpoints)
        .UseSwagger() // for generating OpenApi spec
        .UseSwaggerUI() // for viewing Swagger UI
        .Run(notFoundHandler)

let configureServices (services: IServiceCollection) =
    services
        .AddRouting()
        .AddOxpecker()
        .AddEndpointsApiExplorer() // use the API Explorer to discover and describe endpoints
        .AddSwaggerGen() // swagger dependencies
    |> ignore

要使端点可通过 Swagger 发现，您需要在端点上调用以下函数之一： addOpenApi 或 addOpenApiSimple。

注意：当使用这些函数时，您不需要描述路由参数，它们将自动从路由模板中推断出来。

addOpenApi

此方法用于向端点添加 OpenApi 元数据。它接受带有以下可选参数的 OpenApiConfig 对象

type OpenApiConfig (?requestBody : RequestBody,
                    ?responseBodies : ResponseBody seq,
                    ?configureOperation : OpenApiOperation -> OpenApiOperation) =
    // ...

从传递给 requestBody 和 responseBodies 参数的类型中推断出响应体架构。每个 ResponseBody 对象在序列中都必须具有不同的状态码。configureOperation 参数是一个函数，它允许您对 OpenApiOperation 对象进行非常底层的修改。

addOpenApiSimple

此方法适用于简单情况的一种快捷方式。它接受两个泛型类型参数 - 请求数据和响应数据，因此模式可以从它们推断出来。

let addOpenApiSimple<'Req, 'Res> = ...

如果你的处理程序不接受任何输入，你可以使用unit作为请求数据类型（响应数据也同样适用）。