打开APP
userphoto
未登录

开通VIP,畅享免费电子书等14项超值服

开通VIP
.NET Core 初次上手Swagger

安装NuGet 程序包=》Swashbuckle.AspNetCore

在  Startup.ConfigureServices  方法里添加注册生成器

 1  //注册Swagger生成器,定义一个和多个Swagger 文档 2  services.AddSwaggerGen(c => 3  { 4     c.SwaggerDoc("v1", new Info() { Title = "测试版本", Version = "v1" }); 5  6     c.ResolveConflictingActions(apiDescriptions => apiDescriptions.First()); 7     c.CustomSchemaIds(type => type.FullName); // 解决相同类名会报错的问题 8  9     c.IncludeXmlComments(Path.Combine(Directory.GetCurrentDirectory(), "SwaggerDemo.xml")); // 注释要使用的 XML 文档10  });

 如果需要使用到在页面显示控制器的一些注释,可选择生成-输出-XML文档文件。

1591可免去一些没有加注释的一些警告。

注释实例:

----

 

在  Startup.Configure  方法里添加中间件服务

 //启用中间件服务生成Swagger作为JSON终结点app.UseSwagger();//启用中间件服务对swagger-ui,指定Swagger JSON终结点app.UseSwaggerUI(c =>{      c.SwaggerEndpoint("/swagger/v1/swagger.json", "DemoAPI V1"); });

添加完后,可以自己建控制器了。

注意:控制器必须是API标识的控制器。

里面的方法也必须带有HTTP请求协议。

最后执行访问=》/swagger/index.html

 学习来自依乐祝大佬的文章=》点击进入超时空传送

本站仅提供存储服务,所有内容均由用户发布,如发现有害或侵权内容,请点击举报
打开APP,阅读全文并永久保存 查看更多类似文章
猜你喜欢
类似文章
【热】打开小程序,算一算2024你的财运
基于.NetCore3.1系列 —— 使用Swagger做Api文档 (下篇)
webapi文档描述
还在用Swagger?试试这款零注解侵入的API文档生成工具
5分钟了解swagger
推荐一款 Java 零注解 API 文档生成工具
003 在.Net Core 中使用 Swagger
更多类似文章 >>
生活服务
热点新闻
分享 收藏 导长图 关注 下载文章
绑定账号成功
后续可登录账号畅享VIP特权!
如果VIP功能使用有故障,
可点击这里联系客服!

联系客服