ASP Swagger 文档进阶指南：打造世界一流的 API 文档

1. 理解 Swagger

swagger 是一个开放源代码框架，用于生成 api 文档。它提供了一组规范，使您可以使用 JSON 或 YAML 来描述您的 API。这些规范可以被不同的工具（如 Swagger UI 或 Redoc）解析，以生成人类可读的文档。

2. 安装 Swagger

在 ASP.net core 项目中，您可以使用 NuGet 包管理器来安装 Swagger。在 Package Manager Console 中，运行以下命令：

Install-Package Swashbuckle.Aspnetcore

3. 配置 Swagger

在 Startup.cs 文件中，您需要配置 Swagger。在 ConfigureServices 方法中，添加以下代码：

services.AddSwaggerGen(c =>
{
    c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });
});

在 Configure 方法中，添加以下代码：

app.UseSwagger();
app.UseSwaggerUI(c =>
{
    c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
});

4. 描述您的 API

现在，您可以使用 Swagger 来描述您的 API。在 Controllers 文件夹中，打开您的控制器类。在类声明的顶部，添加以下代码：

[SwaggerTag("Products")]

这将为您的控制器类分配一个标签，使您可以在 Swagger UI 中对它进行分组。

在每个操作方法中，添加以下代码：

[SwaggerOperation("GetProducts")]
[SwaggerResponse(200, "OK", typeof(IEnumerable<Product>))]

这将为您的操作方法分配一个操作 ID 和一个响应代码。您还可以指定响应代码的类型。

5. 生成文档

现在，您可以使用 Swagger 来生成文档。在命令提示符中，运行以下命令：

dotnet swagger generate-document -o .swagger.json --fORMat=openapi

这将生成一个 JSON 文件，其中包含您的 API 的文档。

6. 查看文档

您可以使用 Swagger UI 来查看文档。在浏览器中，打开以下 URL：

Http://localhost:5000/swagger/index.html

您将看到一个交互式文档，其中包含您 API 的所有端点。

7. 维护文档

随着您的 API 的发展，您需要维护您的 Swagger 文档。当您添加或更改 API 的端点时，您需要更新您的 Swagger 文档。

8. 最佳实践

这里有一些编写高质量 ASP Swagger 文档的最佳实践：

• 使用有意义的名称来命名您的端点。
• 在您的端点中使用描述性的参数。
• 为您的端点指定适当的响应代码。
• 使用示例来演示如何使用您的端点。
• 定期维护您的文档。

9. 结论

通过遵循本指南，您可以编写出高质量的 ASP Swagger 文档。这将帮助开发人员更好地理解和使用您的 API。