最近发现一个比较好用的插件,可根据api的功能注释说明一键生成文档以及功能demo;
swaggerUI 是一个简单的Restful API 测试和文档工具。简单、漂亮、易用。通过读取JSON 配置显示API. 项目本身仅仅也只依赖一些 html,css.js静态文件. 你可以几乎放在任何Web容器上使用。
这里可以直接创建一个默认的项目;
添加nuget 组件库 Swashbuckle
代码注释生成文档说明。
Swashbuckle 是通过生成的XML文件来读取注释的,生成 SwaggerUI,JSON 配置中的说明的。
安装时会在项目目录 App_Start 文件夹下生成一个 SwaggerConfig.cs 配置文件,用于配置 SwaggerUI 相关展示行为的。
然后启动项目,访问 http://localhost:61132/swagger/ui/index#/ , 一个漂亮的api文档出现在你的眼前
UI
好了!看完这个就可以尝试着完成自己的api文档了。。。