ASP.NET Core WebAPI帮助页--Swagger简单使用1.0

1、什么是Swagger?

Swagger是一个规范且完整的框架,提供描述、生产、消费和可视化RESTful API,它是为了解决Web API生成有用文档和帮助页的问题。

2、为啥选用swagger?

1)它具有交互式文档、客户端SDK生成和API可发现性等优点。

2)书写api说明文档的工具有很多,但是能称之框架只有swagger

3、Swagger 规范 (swagger.json)

Swagger 流的核心是 Swagger 规范,默认情况下是名为 swagger.json 的文档。 它由 Swagger 工具链(或其第三方实现)根据你的服务生成。 它描述了 API 的功能以及使用 HTTP 对其进行访问的方式。 它驱动 Swagger UI,并由工具链用来启用发现和客户端代码生成。

4、ASP.NET Core 使用Swagger生成api说明文档

4.1引用Nuget包,“Swashbuckle.AspNetCore”

Swashbuckle.AspNetCore 是一个开源项目,用于生成 ASP.NET Core Web API 的 Swagger 文档。

Swashbuckle 有三个主要组成部分:

  • Swashbuckle.AspNetCore.Swagger:将 SwaggerDocument 对象公开为 JSON 终结点的 Swagger 对象模型和中间件。

  • Swashbuckle.AspNetCore.SwaggerGen:从路由、控制器和模型直接生成 SwaggerDocument 对象的 Swagger 生成器。 它通常与 Swagger 终结点中间件结合,以自动公开 Swagger JSON。

  • Swashbuckle.AspNetCore.SwaggerUI:Swagger UI 工具的嵌入式版本。 它解释 Swagger JSON 以构建描述 Web API 功能的可自定义的丰富体验。 它包括针对公共方法的内置测试工具。

4.2添加并配置Swagger中间件

在Startup.cs类中,编辑ConfigureServices方法

public void ConfigureServices(IServiceCollection services)

{

services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2);

services.AddSwaggerGen(c =>

{

c.SwaggerDoc("V1.0", new Swashbuckle.AspNetCore.Swagger.Info

{

Title = "My WebAPI",

Description="API说明文档",

Version = "V1.0",

Contact=new Swashbuckle.AspNetCore.Swagger.Contact { Name="Blog.Core"}

});

});

}

4.3在Startup.cs类中Configure 方法中,启用中间件生成Json文档和SwaggerUI提供服务

public void Configure(IApplicationBuilder app, IHostingEnvironment env)

{

if (env.IsDevelopment())

{

app.UseDeveloperExceptionPage();

}

app.UseSwagger();

app.UseSwaggerUI(c => {

c.SwaggerEndpoint("/swagger/v1/swagger.json", "My Web API");

});

app.UseMvc();

}

到此,已经完成Swagger的添加,启动项目,在端口后面输入/Swagger,然后回车,就可看到生成API文档效果了

注意:如果ConfigureServices 方法中的  services.AddSwaggerGen 注册的一个名字 c.SwaggerDoc("v1.0"的V1.0, 和Configure 方法中的app.UseSwaggerUI(c => {

c.SwaggerEndpoint("/swagger/v1/swagger.json", "My Web API");

})的V1不一致,将会出现下面的bug

5、总结

通过本篇文章的简单介绍,我们可以简单了解到:

1、什么是Swagger?

2、swagger的优点。

3、ASP.NET Core 使用Swagger生成api说明文档。

4、ASP.NET Core使用Swagger中常遇到的错误

 源码已经放到Github上面,地址是:https://github.com/xiaoerhao/Blog.Core

写博客也是为了督促自己学习和记录学习的内容,最后感谢"老张的哲学"对于知识的分享,很多时候都是在他们这些前辈的基础上去学习,下一次再分享关于swagger api文档注释和汉化。

640?wx_fmt=jpeg

原文地址:https://www.cnblogs.com/Erhao/p/11016133.html

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/315518.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

Codeforces Global Round 12 E. Capitalism 差分约束

传送门 题意: 思路: 一开始被题意迷惑了,没看出来差分约束,老菜鸡啦。首先看到ajai1a_ja_i1aj​ai​1可以把aia_iai​分成奇偶,让后这个图就变成一个二分图了。再考虑如何连边: (1) 对于b1b1b1的情况&…

ARC114E - Paper Cutting 2(组合数学,概率与期望)

ARC114E - Paper Cutting 2 Solution 考场上时间不够,没刚出来QAQ。 做法和官解本质相同,只是官解运用期望的线性性直接导出答案,而这里是对于所有方案统计贡献在除以方案数,从期望的定义上计算答案。可能稍显复杂。 Part one…

8个月打磨,一份送给程序员的「分布式系统」合集

这里是Z哥的个人公众号每周五早8点 按时送达当然了,也会时不时加个餐~我的第「75」篇原创敬上整理好的文章目录在文末,可直接拉到最后是的,这份礼物最佳受众是程序员。但是,如果你不是程序员,相信这些能使你…

HDU - 6071 Lazy Running 同余最短路 + 分层

传送门 题意: 给定四个点构成一个环,给出四个点之间的距离,让后从222号点出发,最终回到222号点,求经过的距离>k>k>k的最小距离。 思路: 由于从222开始,最终在222结束,所以…

CF1398F

CF1398F Solution 我又来贡献暴力做法了。。。听说两只log不可能过1e6? 有一个显然的想法是: 我们先预处理一个aia_iai​表示第iii个位置的最长后缀长度,满足该后缀中不同时存在0和1。 假设我们要求xixixi的答案,那么一个位置jjj可以作…

【翻译】无需安装Python,就可以在.NET里调用Python库

原文地址:https://henon.wordpress.com/2019/06/05/using-python-libraries-in-net-without-a-python-installation/pythonnet这个屌爆的项目的出现,使得我们可以用一种新的方式,让C#可以和Python之间进行互操作。但是它的设置和部署可能有点…

Codeforces Round #706 (Div. 2) E. Garden of the Sun 思维构造

传送门 题意: 给你一个nmnmnm的矩阵,其中包含字符′.′.′.′和′X′X′X′,你可以将任何′.′.′.′改成′X′X′X′,现在问你能否通过修改一些′.′.′.′来使′X′X′X′联通且不存在环。保证原本的′X′X′X′没有任何两个相…

CF1067E Random Forest Rank(树形dp,概率与期望,线性代数)

CF1067E Random Forest Rank Solution 考虑树的邻接矩阵的秩的意义,不难发现相当于每个点找一个“代表”,对于一个点xxx,它的“代表”为一个与xxx相邻的结点,要求保证所有点的“代表”不重复,求能找到“代表”的点的…

Ocelot(六)- 架构图

简介Ocelot是一个用.NET Core实现并且开源的API网关,它功能强大,包括了:路由、请求聚合、服务发现、认证、鉴权、限流熔断、并内置了负载均衡器与Service Fabric、k8s 集成。这些功能只都只需要简单的配置即可完成。架构图Ocelot的目标是使用…

P5170 【模板】类欧几里得算法(类欧)

P5170 【模板】类欧几里得算法 Description 要求在O(lgn)O(lgn)O(lgn)的时间内求出: ∑i0n⌊aibc⌋\sum_{i 0}^n{\lfloor\frac{aib}{c}\rfloor}∑i0n​⌊caib​⌋ ∑i0ni⌊aibc⌋\sum_{i 0}^n{i\lfloor\frac{aib}{c}\rfloor }∑i0n​i⌊caib​⌋ ∑i0n⌊aibc⌋2…

AtCoder Beginner Contest 192 F - Potion 背包dp

传送门 题意: 给你nnn个数,让后让你选出来kkk个AAA,把他们求和,之后再递增kkk直到正好达到xxx,求最小的递增次数。 思路: 转化一下题意就是求∑Ax(modlen)\sum Ax(\bmod\ \ len)∑Ax(mod len)&#xff0…

基于Dapper的开源Lambda扩展,且支持分库分表自动生成实体

LnskyDB是基于Dapper的Lambda扩展,支持按时间分库分表,也可以自定义分库分表方法开源地址 https://github.com/liningit/LnskyDB在此非常感谢SkyChenSky其中lambda表达式的解析参考了他的开源项目下面是用ProductSaleByDayEntity作为示例,其中StatisticalDate为分库分表字段,如…

P4887 【模板】莫队二次离线(第十四分块(前体))

P4887 【模板】莫队二次离线(第十四分块(前体)) Solution 简单学习了一下二次离线莫队,写了个板子题。 这题直接莫队时间复杂度为O(Cnn)O(Cn\sqrt n)O(Cnn​),其中C(14k)C\binom{14}{k}C(k14​),显然不太行。 我们…

P1297 [国家集训队]单选错位 期望

传送门 题意&#xff1a; 思路&#xff1a; 手推了一下没想到还真的能过。 对于相邻的两个数aia_iai​和ai1a_{i1}ai1​&#xff0c;分两种情况讨论&#xff1a; (1) ai<ai1a_i<a_{i1}ai​<ai1​ 时&#xff0c;答案在[1,ai][1,a_i][1,ai​]的范围内概率为aiai1\fra…

也读《人月神话》:没有银弹的软件工程

一、关于人月神话这本书记得在上大学的时候&#xff0c;就经常听学长和老师讲起《人月神话》&#xff0c;但是却一直没有阅读。记得当时一听到这个书名&#xff0c;还以为是个神马科幻类别的书&#xff0c;结果是个软件工程方面的书籍。这本书是“图灵奖得主、“IBM360系统之父…

CF1088F. Ehab and a weird weight formula(倍增)

CF1088F. Ehab and a weird weight formula Solution 这题大概是个大力找性质题&#xff08;莫名感觉学习文化课有利于找性质&#xff1f;&#xff01;&#xff1f;&#xff09;。 性质1&#xff1a;不难发现一个点比它权值小的有且仅有一个&#xff08;最小权点除外&#x…

P6154 游走 概率dp

传送门 题意&#xff1a; 思路&#xff1a; 给你个DAGDAGDAG&#xff0c;由于每一条路径出现概率相等&#xff0c;那么期望就是总长度路径个数\frac{总长度}{路径个数}路径个数总长度​。设f[i]f[i]f[i]表示到iii这个点的总长度&#xff0c;g[i]g[i]g[i]表示到iii这个点路径的…

[译]如何在C#中调试LINQ查询

LINQ是我在C#中最喜欢的功能之一。它让代码看起来更漂亮美观。我们得到了一个易于编写和理解的简洁函数式语法。好吧&#xff0c;至少我们可以使用LINQ方法的语法风格。LINQ很难进行调试。我们无法知道该查询内部发生了什么。我们可以看到输入和输出&#xff0c;但这就是它的全…

CF1303F - Number of Components(并查集)

CF1303F - Number of Components Solution 思路还是有点妙的。 容易想到并查集&#xff0c;但是并查集不容易维护删边&#xff0c;怎么办呢&#xff1f; 我们考虑拆贡献&#xff0c;把加边的贡献和删边的贡献拆开&#xff0c;分别维护。 只加边就是四连通加边&#xff0c;算…

CodeForces - 375D Tree and Queries 树启 + 思维

传送门 题意&#xff1a; 思路&#xff1a; 很明显子树问题会想到树启&#xff0c;让后如何updateupdateupdate呢&#xff1f;一个显然的思路就是维护一个树状数组&#xff0c;查询次数>kj>k_j>kj​的个数。但是这样复杂度是O(nlog2n)O(nlog^2n)O(nlog2n)的&#xf…