swagger:API在线文档自动生成框架
2017-12-15 17:06
597 查看
传统的API从开发测试开始我们经常借用类似Postman、fiddle等等去做接口测试等等工具;Swagger 为API的在线测试、在线文档提供了一个新的简便的解决方案;
引用NuGet包:Swashbuckle.AspNetCore ;
包含如下部分:
Swashbuckle.AspNetCore.Swagger: 一些模型实体定义
Swashbuckle.AspNetCore.SwaggerGen: Swagger生成器
Swashbuckle.AspNetCore.SwaggerUI:Swagger UI工具
配置:startup.cs
注入swagger:
编译运行,下面两个网址:
API文档界面:http://localhost:<random_port>/swagger
API的restful说明json文件:http://localhost:<random_port>/swagger/v1/swagger.json
文档:
官网:https://swagger.io
微软文档:https://docs.microsoft.com/en-us/aspnet/web-api/overview/getting-started-with-aspnet-web-api/creating-api-help-pages
NetCore使用:https://docs.microsoft.com/en-us/aspnet/core/tutorials/web-api-help-pages-using-swagger?tabs=visual-studio
博客资源:http://www.cnblogs.com/dotNETCoreSG/p/aspnetcore_02-09_web-api-help-pages-using-swagger.html
使用Swagger
NET使用:Swagger-Net引用NuGet包:Swashbuckle.AspNetCore ;
包含如下部分:
Swashbuckle.AspNetCore.Swagger: 一些模型实体定义
Swashbuckle.AspNetCore.SwaggerGen: Swagger生成器
Swashbuckle.AspNetCore.SwaggerUI:Swagger UI工具
配置:startup.cs
注入swagger:
public void ConfigureServices(IServiceCollection services) { services.AddMvc(); // Register the Swagger generator, defining one or more Swagger documents services.AddSwaggerGen(c => { c.SwaggerDoc("v1", new Info { Title = "My API", Version = "v1" }); }); } public void Configure(IApplicationBuilder app, IHostingEnvironment env) { if (env.IsDevelopment()) { app.UseDeveloperExceptionPage(); } // Enable middleware to serve generated Swagger as a JSON endpoint. app.UseSwagger(); // Enable middleware to serve swagger-ui (HTML, JS, CSS, etc.), specifying the Swagger JSON endpoint. app.UseSwaggerUI(c => { c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1"); }); app.UseMvc(); }
编译运行,下面两个网址:
API文档界面:http://localhost:<random_port>/swagger
API的restful说明json文件:http://localhost:<random_port>/swagger/v1/swagger.json
文档:
官网:https://swagger.io
微软文档:https://docs.microsoft.com/en-us/aspnet/web-api/overview/getting-started-with-aspnet-web-api/creating-api-help-pages
NetCore使用:https://docs.microsoft.com/en-us/aspnet/core/tutorials/web-api-help-pages-using-swagger?tabs=visual-studio
博客资源:http://www.cnblogs.com/dotNETCoreSG/p/aspnetcore_02-09_web-api-help-pages-using-swagger.html
相关文章推荐
- 使用 Swagger 自动生成 ASP.NET Core Web API 的文档、在线帮助测试文档(ASP.NET Core Web API 自动生成文档)
- 使用swagger实现在线api文档自动生成 在线测试api接口
- 使用 Swagger 自动生成 ASP.NET Core Web API 的文档、在线帮助测试文档(ASP.NET Core Web API 自动生成文档)
- Spring Boot如何让Web API自动生成文档,并解决swagger-annotations的API注解description属性废弃的问题
- Spring MVC 集成 Swagger,API文档自动生成~
- 最近使用springfox(swagger)自动生成api文档时问题心得
- 一款RESTFUL接口的文档在线自动生成+功能测试功能软件——Swagger简介
- 用Swashbuckle给ASP.NET Core的项目自动生成Swagger的API帮助文档
- API文档自动生成,Swagger的配置
- springmvc集成Swagger自动生成api文档
- 如何使 WebAPI 自动生成漂亮又实用在线API文档
- 如何使 WebAPI 自动生成漂亮又实用在线API文档
- java服务器使用swagger自动生成API文档
- Swashbuckle 如何使 WebAPI 自动生成漂亮又实用在线API文档[转]
- ,有一款RESTFUL接口的文档在线自动生成+功能测试功能软件——Swagger UI,具体配置过程可移步《Spring Boot 利用 Swagger 实现restful测试》
- 用Swashbuckle给ASP.NET Core的项目自动生成Swagger的API帮助文档
- 如何开发一个java开源框架-----Jvn框架之实现自动生成在线文档(第七讲)
- SpringBoot整合Swagger自动生成API文档
- 如何使 WebAPI 自动生成漂亮又实用在线API文档
- SwaggerUI自动生成API文档(SwaggerUI+SpringBoot)