ASP.NET Core 中的 OpenAPI 支持

ASP.NET Core 支持在基于控制器和最小 API 应用中生成 OpenAPI 文档。 OpenAPI 规范是用于记录与编程语言无关的 HTTP API 的标准。

ASP.NET Core 应用通过 Microsoft.AspNetCore.OpenApi 包为在应用中生成有关终结点的信息提供内置支持。

生成 OpenAPI 文档

创建项目

$ dotnet new web -o OpenAPISamples

安装 Microsoft.AspNetCore.OpenApi

$ dotnet add package Microsoft.AspNetCore.OpenApi

配置 OpenAPI 文档生成

var builder = WebApplication.CreateBuilder(args);

// 使用 AddOpenApi 扩展方法添加 OpenAPI 服务
builder.Services.AddOpenApi();

var app = builder.Build();

// 在开发环境下
if (app.Environment.IsDevelopment())
{
    // 使用 MapOpenApi 扩展方法在应用上设置一个终结点，以查看 JSON 格式的 OpenAPI 文档
    app.MapOpenApi();
}

app.MapGet("/", () => "Hello World!");

app.Run();

启动应用并导航到 https://localhost:<port>/openapi/v1.json 以查看生成的 OpenAPI 文档。

{
  "openapi": "3.0.1",
  "info": {
    "title": "OpenAPISamples | v1",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "http://localhost:5252/"
    }
  ],
  "paths": {
    "/": {
      "get": {
        "tags": [
          "OpenAPISamples"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": { },
  "tags": [
    {
      "name": "OpenAPISamples"
    }
  ]
}

使用 OpenAPI 文档

将 Scalar 用于交互式 API 文档

Scalar 是 OpenAPI 的开源交互式文档 UI。 Scalar 可与 ASP.NET Core 提供的 OpenAPI 终结点集成。 若要配置 Scalar，请安装 Scalar.AspNetCore 包。

安装 Scalar.AspNetCore

$ dotnet add package Scalar.AspNetCore

启用 Scalar 生成 API 参考文档

using Scalar.AspNetCore;

var builder = WebApplication.CreateBuilder(args);

// 使用 AddOpenApi 扩展方法添加 OpenAPI 服务
builder.Services.AddOpenApi();

var app = builder.Build();

// 在开发环境下
if (app.Environment.IsDevelopment())
{
    // 使用 MapOpenApi 扩展方法在应用上设置一个终结点，以查看 JSON 格式的 OpenAPI 文档
    app.MapOpenApi();
    // 使用 MapOpenApi 扩展方法基于 OpenAPI 文档生成美观的 API 参考文档
    app.MapScalarApiReference();
}

app.MapGet("/", () => "Hello World!");

app.Run();