Asp.Net Core 轻松学-利用 Swagger 自动生成接口文档 (2)

上面的代码在 ValuesController 上增加了一个特性 ApiExplorerSettings(GroupName = "演示分组"),这样就完成了一个分组设置；不过，如果希望该分组能在浏览器中显示，我们还需要在 Startup.cs 中定义的 docs 数组中增加 "演示分组" 名称

static string[] docs = new[] { "未分类", "演示分组" }; 4. 定义 API 接口友好名称

4.1 下面对每个接口进行友好名称显示的定义，通过编写 xml 注释，并在 summary 节点书写接口名称，即可自动显示到 API 文档上面

/// <summary> /// 获取数组 /// </summary> /// <remarks> /// <code> /// 输出参数：["value1", "value2"] /// </code> /// </remarks> /// <returns></returns> [HttpGet] public ActionResult<IEnumerable<string>> Get() { return new string[] { "value1", "value2" }; }

4.2 刷新网页，可以看到，接口友好名称已经显示出了了

结语

Swagger 基础应用可以帮助我们做到以下内容，现在就开始应用到程序中吧

自动生成 API 文档

对每个控制器进行分组

自动抓取开发人员编写的 XML 注释

在 API 文档界面进行即时测试

还有很多过滤等功能，下次有机会再试试

源码下载

https://files.cnblogs.com/files/viter/Ron.SwaggerTest.zip