.NetCore + NSwag 生成可交互API文档
在后台接口开发中,API文档作为和前端交流的重要工具,必然是不可马虎的,传统方式将文档写入Word文档中,但是缺点也显著,
1. 文档不易修改
2. 文档阅读不够直观
有没有什么方式可以让API文档可以根据代码的变化而自动更改,并且文档可以直观的交互?
探索中发现了NSwag插件,可以集成到.NetCore项目中,这样就可以自动生成直观的可交互API文档。
首先在项目中通过NuGet安装如下插件:
然后,需要在StartUp中加入代码即可:
![](https://images.cnblogs.com/OutliningIndicators/ContractedBlock.gif)
public void Configure(IApplicationBuilder app, IHostingEnvironment env) { app.UseStaticFiles(); // Enable the Swagger UI middleware and the Swagger generator app.UseSwaggerUi(typeof(Startup).GetTypeInfo().Assembly, settings => { settings.GeneratorSettings.DefaultPropertyNameHandling = PropertyNameHandling.CamelCase; }); app.UseMvc(); }
效果如下:
这样的文档阅读起来,是不是很直观呢?
Demo地址:https://files.cnblogs.com/files/devin_zhou/Swagger_Api.zip