一文读懂 ASP Swagger 文档：快速入门 RESTful API 开发

ASP swagger 文档的使用步骤如下：

1. 安装 Swagger 生成器
2. 在 api 项目中引用 Swagger 生成器
3. 定义 API 路由和数据模型
4. 使用 Swagger 生成器生成文档
5. 发布 Swagger 文档

下面提供一个简单的 ASP.net core WEB API 项目的 Swagger 文档演示代码：

// Install Swagger Generator package
Install-Package Swashbuckle.Aspnetcore

// Add Swagger services to the project
public void ConfigureServices(IServiceCollection services)
{
    services.AddSwaggerGen(c =>
    {
        c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });
    });

    // ...
}

// Configure Swagger middleware
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    // ...

    // Enable middleware to serve generated Swagger as a JSON endpoint
    app.UseSwagger();

    // Enable middleware to serve Swagger UI (html, js, CSS, etc.)
    app.UseSwaggerUI(c =>
    {
        c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
    });

    // ...
}

// Define API route
[HttpGet("/api/values")]
public IEnumerable<string> Get()
{
    return new string[] { "value1", "value2" };
}

运行项目后，在浏览器中访问 http://localhost:5000/swagger 即可查看生成的 Swagger 文档。

Swagger 文档提供了丰富的功能，包括：

• API 路由列表
• 请求参数说明
• 响应格式示例
• API 授权信息
• API 历史版本记录

开发人员可以使用 Swagger 文档轻松了解 API 的使用方法，并快速集成 API 到应用程序中。