ASP.NetCore使用Swagger实战

踩坑不背锅，.NET Core 试深浅 关于Swagger什么是swagger所带来的辅佐 行使Swagger

关于Swagger

什么是swagger

使人和计较机在看不到源码可能看不到文档可能不能通过收集流量检测的环境下能发明和领略各类处事的成果。

Swagger™ 的方针是为 REST APIs 界说一个尺度的，与说话无关的接口。只必要凭证它的类型去界说接口及接口相干的信息。再通过Swagger衍生出来的一系列项目和器材，就可以做到天生各类名目标接口文档，天生多种说话的客户端和处事端的代码，以及在线接口调试页面等。

所带来的辅佐

当项目处于启动阶段
假若有了不变的靠山框架，直接依据营业需求编写处事端被挪用层的代码（即controller及其入参出参工具），然后通过Swagger天生相干描写文件，行使者就可以直接行使了。
假如靠山框架不成熟或在计划中，可是依据营业需求我们可以完成更多的事变而不是守候，先按照数据需求编写Swagger描写文件，通过该描写文件天生接口文档，指引项目标相干开拓。
当项目处于迭代阶段
在项目标一连开拓中，后端职员无需存眷Swagger描写文件和接口文档，有需求改观导致接口变革，可直接编程实现，然后天生新的描写文件和接口文档后，给到前端即可。

行使Swagger

起首，先建设一个新的WebAPI项目，并在Nuget中找到对应的包，搜刮Swashbuckle会呈现许多应用包，可以按照描写选择本身必要的引用。我在这里行使的是Swashbuckle.AspNetCore.Filters

接下来在Startup中插入如下代码
注册处事

services.AddSwaggerGen(options => { options.SwaggerDoc("v1", new OpenApiInfo { Title = "HTTP API 目次", Version = "v1", Description = "目次微处事HTTP API。" }); });

中间件

//启用中间件处事天生Swagger作为JSON终结点 app.UseSwagger(); //启用中间件处事对swagger-ui，指定Swagger JSON终结点 app.UseSwagger().UseSwaggerUI(c => { c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1"); });

然后，就可以行使了，哀求对应地点 https://localhost:44375/swagger/index.html，此刻就可以看到示例代码中的WeatherForecast.cs了。

到此这篇关于ASP.NetCore行使Swagger拭魅战的文章就先容到这了,更多相干ASP.NetCore行使Swagger内容请搜刮剧本之家早年的文章或继承赏识下面的相干文章但愿各人往后多多支持剧本之家！

（编辑：湖南网）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!