Asp.Net Core实战-Swagger接口文文档-51CTO.COM

引言

在Asp.Net Core项目中，前后端分离的开发模式越来越普及。为了提升开发效率，减少沟通成本，自动生成清晰、易读的API文档变得尤为重要。Swagger作为一个流行的API开发工具，可以自动生成API文档，并提供交互式界面进行测试，极大地简化了API的开发和文档化过程。本文将详细介绍如何在Asp.Net Core项目中集成Swagger，并给出例子代码。

Swagger简介

Swagger是一个规范和完整的框架，用于生成、描述、调用和可视化RESTful风格的Web服务。Swagger遵循OpenAPI规范（原Swagger规范），允许开发人员设计、构建、记录和使用RESTful Web服务。Swagger工具集包括Swagger Editor、Swagger UI和Swagger Codegen，分别用于API文档的编写、API文档的展示和客户端代码的自动生成。

集成Swagger到Asp.Net Core

在Asp.Net Core项目中集成Swagger，主要分为以下几个步骤：

安装Swagger NuGet包在项目中通过NuGet包管理器安装Swashbuckle.AspNetCore包。可以使用NuGet Package Manager Console执行以下命令：

Install-Package Swashbuckle.AspNetCore

或者使用Visual Studio的NuGet包管理器界面进行安装。

配置Swagger服务在Startup.cs文件的ConfigureServices方法中配置Swagger服务。

public void ConfigureServices(IServiceCollection services)
{
    services.AddControllers();

    // 添加Swagger生成器，定义一个和多个Swagger文档
    services.AddSwaggerGen(c =>
    {
        c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });

        // 为Swagger UI设置XML注释路径
        var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
        var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
        c.IncludeXmlComments(xmlPath);
    });
}

注意：为了让Swagger显示控制器和方法的注释，你需要在项目属性中启用XML文档生成，并确保生成的XML文件路径正确。

启用Swagger中间件在Startup.cs文件的Configure方法中启用Swagger中间件，以便在应用程序中提供Swagger UI。

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
    }

    app.UseHttpsRedirection();

    app.UseRouting();

    app.UseAuthorization();

    // 启用中间件服务生成Swagger作为JSON终结点
    app.UseSwagger();

    // 启用中间件服务对swagger-ui，指定Swagger JSON终结点
    app.UseSwaggerUI(c =>
    {
        c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
    });

    app.UseEndpoints(endpoints =>
    {
        endpoints.MapControllers();
    });
}

为控制器和动作添加注释在你的控制器和动作方法上使用XML注释来描述你的API。例如：

/// <summary>
/// 学生控制器
/// </summary>
[ApiController]
[Route("[controller]")]
public class StudentsController : ControllerBase
{
    /// <summary>
    /// 获取所有学生信息
    /// </summary>
    /// <returns>学生列表</returns>
    [HttpGet]
    public IActionResult GetStudents()
    {
        // 实现逻辑
        return Ok(new List<string> { "Tom", "Jerry" });
    }

    // 其他动作方法...
}

访问Swagger UI

启动你的Asp.Net Core应用程序，并在浏览器中访问http://localhost:<your-port>/swagger（默认端口通常是5000或5001）。你将看到Swagger UI界面，列出了所有的API端点，包括方法、参数和响应类型等信息。你可以直接在这个界面上进行API的调用和测试。

结论

通过集成Swagger到Asp.Net Core项目中，你可以自动生成清晰、易读的API文档，并提供交互式界面进行测试，极大地提升了开发效率和团队协作效率。