.NetCore + NSwag 生成可交互API文档

在后台接口开发中，API文档作为和前端交流的重要工具，必然是不可马虎的，传统方式将文档写入Word文档中，但是缺点也显著，

1. 文档不易修改

2. 文档阅读不够直观

有没有什么方式可以让API文档可以根据代码的变化而自动更改，并且文档可以直观的交互？

探索中发现了NSwag插件，可以集成到.NetCore项目中，这样就可以自动生成直观的可交互API文档。

微软官方文档：https://docs.microsoft.com/en-us/aspnet/core/tutorials/getting-started-with-nswag?view=aspnetcore-2.0

首先在项目中通过NuGet安装如下插件：

然后，需要在StartUp中加入代码即可：

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{app.UseStaticFiles();// Enable the Swagger UI middleware and the Swagger generatorapp.UseSwaggerUi(typeof(Startup).GetTypeInfo().Assembly, settings =>{settings.GeneratorSettings.DefaultPropertyNameHandling = PropertyNameHandling.CamelCase;});app.UseMvc();
}

View Code

效果如下：

这样的文档阅读起来，是不是很直观呢？

Demo地址：https://files.cnblogs.com/files/devin_zhou/Swagger_Api.zip

转载于:https://www.cnblogs.com/devin_zhou/p/9043751.html

.NetCore + NSwag生成可交互API文档相关推荐

ABP给WebApi添加SwaggerUI,生成可交互接口文档
在ABP模板项目中,通过SwaggerUI可以为我们的WebApi生成动态的可交互接口文档页面,从而可以很方便的测试调用我们的WebApi接口. 一.集成Swagger 右键项目YoYo.Web,打开 ...
Api文档生成工具与Api文档的传播（pdf）
点击查看apidoc生成文档demo 1 环境和工具 win10 apidoc:注释生成api文档 wkhtmltopdf:apidoc生成的是html,不适合传播,于是通过wkhtmltopdf将h ...
Maven学习总结（43）——利用javadoc插件生成项目的API文档
在进行Java学习的时候,相信大家都看过在线或者下载的java api文档,可能是html格式或者chm格式的,其实这些参考文档也是很容易生成的,这里介绍一个maven的插件来实现项目代码文档的生成. ...
CMDB建设补充：教你用django+drf 怎么去生成漂亮的API文档
废话不多说,先看效果图安装插件 pip install drf_yasg 在settings.py的INSTALLED_APPS里添加drf_yasg 在urls.py里面添加下面代码 from r ...
使用apidoc文档神器，快速生成api文档
写完api接口,就需要编写api文档了,如果一个个手写的话就很麻烦,就得使用apidoc只需要通过写注释,就可以快速生成文档了. 安装第一步先安装全局模块apidoc. npm install ap ...
Spring Boot整合swagger2(生成有左右菜单式的api文档界面）
一.pom.xml内容:  <dependency><groupId>io.spri ...
SpringBoot——SpringBoot集成Swagger生成API文档
文章目录: 1.写在前面 2.步骤详解 2.1 pom文件中添加Swagger依赖 2.2 在application.properties核心配置文件中配置Swagger 2.3 编写需要生成API文 ...
knife4j API文档生成使用流程及详解
目录初始化流程详细注解分析 @Api @ApiOperation @ApiModelProperty @ApiImplicitParam @ApiImplicitParams @ApiIgnore ...
admin.php生成地址,FastAdmin命令行一键生成API文档
一键生成API文档 FastAdmin中的一键生成API文档可以在命令行或后台一键生成我们API接口的接口测试文档,可以直接在线模拟接口请求,查看参数示例和返回示例. 准备工作请确保你的API模块下 ...
pythonapi是什么意思_API是什么意思？API文档又是什么意思？
展开全部 API(Application Programming Interface,应用程序编程接口)是一些预先定义的函数,目的是提供应用程序与开发人员基于某软件或硬件323131333532363 ...

.NetCore + NSwag生成可交互API文档

.NetCore + NSwag 生成可交互API文档

.NetCore + NSwag生成可交互API文档相关推荐

最新文章

热门文章