前言:微软于前天发布.net core 3.1正式版,并将长期支持3.1。所以我听到这个消息后就急忙下载.net core 3.1的SDK和Runtime,应该是公司最先用3.1的攻城狮了。
OK!废话少说,今天的目的是基于.net core 3.1建一个web api的项目
先下载.net core 3.1的SDK(开发.net core项目时会用到)和Runtime(用来运行.net core的应用程序)
地址:https://dotnet.microsoft.com/download/visual-studio-sdks?utm_source=getdotnetsdk&utm_medium=referral
创建ASP.NET Core web项目 ps:不要选错了
这里说一下项目目录下的各个文件的作用
引入Swashbuckle.AspNetCore程序包
执行以下命令
Install-Package Swashbuckle.AspNetCore -Version 5.0.0-rc4
添加 并配置Swagger中间件
services.AddSwaggerGen(c =>
{
c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });
});
app.UseSwagger();
app.UseSwaggerUI(c =>
{
c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
});
现在添加一个控制器,写一个接口看看能不能出来
地址栏改一下
swagger/index.html
如果对接口做了xml注释,要在Startup添加如下代码,才可以显示出来
先引入NuGet包:Microsoft.Extensions.PlatformAbstractions
然后右键属性
再在Startup中添加下面的代码
var basePath = PlatformServices.Default.Application.ApplicationBasePath;
//Core.Admin.webapi.xml是我的项目生成XML文档的后缀名,具体的以你项目为主
var xmlPath = Path.Combine(basePath, "Core.Admin.webapi.xml");
c.IncludeXmlComments(xmlPath);
运行项目,注释已经出来了
在launchSettings.json中更改一下launchUrl这个环境变量,这样就不用每次都改地址栏了
最后附上微软官方教程地址
https://docs.microsoft.com/zh-cn/aspnet/core/tutorials/getting-started-with-swashbuckle?view=aspnetcore-3.1&tabs=visual-studio
转自:https://www.cnblogs.com/zhangnever/p/11915509.html
推荐阅读:西宁之窗
-
音·忆|李宗盛最动人的10句歌词,唱尽了多少
可能有很多年轻人不理解,为什么有那么多人钟爱听李宗盛?出道早?资历深?有才华?唱功好?其实都不准确。初听一首歌,你一定是奔着旋律去的。但李宗盛的歌不一样。本以为...
2020-01-14 -
陈赫的“挚爱”佛跳墙有多奢侈?看到原材料后,
佛跳墙对于很多吃货而言应该并不会感到陌生,作为国菜的门面之一,佛跳墙是福建当地的名菜,属于闽菜系。而作为大吃货的陈赫,曾经在上一档综艺节目时就点名要吃佛跳墙,气...
2020-01-14 -
带你看看刘敏涛的豪宅,全屋家具都是实木的,拍
带你看看刘敏涛的豪宅,全屋家具都是实木的,拍戏捞金能力很恐怖刘敏涛是一位特别优秀的演员,她在很多经典的影视剧中都有相当出彩的表演。我们除了在一些影视剧中能够看到...
2020-01-14 -
紫薇真的单纯吗?看到她夺回尔康的方法,网友:
《还珠格格》这个电视剧相信大家都是看过的了,这部承载着我们青春回忆的电视剧,在我们很小的时候,就开始看这个电视剧,剧中的每个人都有着自己的特色,尤其是小燕子和紫...
2020-01-14 -
李佳琪问朱一龙,拍身体护肤的时候为什么要穿衣
朱一龙和李佳琪在做直播的时候,李佳琪问朱一龙:拍身体护肤的时候为什么要穿衣服,朱一龙回答脱了也不能播呀,李佳琪说他真是个老实人~朱一龙总给人一种腼腆害羞的感觉,...
2020-01-14 -
《明侦》注定了越往后拍越难拍,创新不易,突破
《明星大侦探》这个节目自第一季开播后变俘获了一大批粉丝的青睐,在后面陆续几季中更是脑洞惊天 悬案频出,从一档另类综艺慢慢的成长为国内娱综的领头羊,之所以说它另类...
2020-01-13