.Net Core3.1下使用Swagger搭建web api项目

原创 于 2020-08-14 10:02:43 发布 · 377 阅读 · 1 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#.net

本文介绍了如何在.Net Core 3.1环境下搭建web API项目，并利用Swagger生成API文档。首先，下载.NET Core 3.1 SDK和Runtime，然后创建ASP.NET Core Web项目，接着引入Swashbuckle.AspNetCore程序包并配置Swagger中间件。通过添加控制器和接口，展示Swagger如何显示接口信息。最后，讲解了如何使接口注释在Swagger中显示，并修改launchSettings.json以方便访问。

 

前言：微软于前天发布.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:不要选错了😂

这里说一下项

最低0.47元/天 解锁文章
.NetCore3.1——Swagger简单配置使用
qiaofan_乔凡的博客
12-31 3455
.NetCore3.0-3.1版本 Swagger 一、安装Swagger 根据官网文档安装Swashbuckle.AspNetCore 命令行Install-Package Swashbuckle.AspNetCore -Version 5.0.0-rc4 也可以通过Nuget搜索Swashbuckle.AspNetCore 安装 此处要注意包的版本问题 二、配置 在Startup中配置服务如图...
某项目的后台WebApi项目 for .net core 3.1 C#
11-20
某架构师review代码后，评价为简洁干练、功能丰富。 包含swagger文档、公共的自定义api入参、出参、用户菜单授权协议、错误处理等，可谓开箱修改即用，是你学习或者开发的最佳辅助代码。
DatingApp.API：.NET Core 3.1 Web API项目
02-13
DatingApp.API：.NET Core 3.1 Web API项目
.Net Core3.1下用Swagger搭建web api（1）
qq_35624605的博客
03-20 382
基于.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=refe...
谈谈如何在 .net Core 3.1 WebAPI项目中配置Swagger在线接口文档
覃鸿宇的博客
04-27 1059
前言 与往常一样，喜欢在前言中写关于文章转载或者写下的原因。近日，在做基于钉钉接口的二次开发，从前喜欢pc端的web应用，突然转到移动端的开发时突然发现知识不够用，特别是关于web api这块。前后端分离是局势，在习惯了MVC的代码书写形式时，转到去写前端接口变得无法是从。但是就是在这样的环境逼迫下，我们才不断的去积累新的知识，不断加深自己的功力。 下面进入正题 在.netCore中，我们可...
通过.NetCore3.1 WebApi+SqlSuagr构建Api项目批量生成实体类【02】
12-25
最近项目需要用SqlSugar重构老项目，由于涉及业务表200余张，手动去copy效率太低，此时分享一个工具给大家，下载即可运行。https://blog.csdn.net/qq_15632461/article/details/111698942
.NET Core 3.1基础项目框架，适用于Web API开发
“szOA.Core.rar”是一个基于 .NET Core 3.1 构建的基础性后端开发项目压缩包，主要用于帮助初学者快速理解并掌握 ASP.NET Core 框架下的 Web API 开发流程。该项目以现代化的前后端分离架构为设计导向，强调通过 ...
.Net-Core-Training:.Net Core 3.1探索自学练习
03-17
使用ASP.NET Core可以快速搭建RESTful API服务，通过中间件（Middleware）实现请求处理。同时，可以集成Swagger或NSwag工具，为API生成文档和客户端SDK，便于调试和使用。对于测试，可以利用xUnit或NUnit进行单元...
.Net Core 3.1 REST API 集成视图与EF的示例应用
标题《DotnetCoreWebAPI：带有Views示例应用程序的.Net Core 3.1 Rest API》所描述的是一个基于 ASP.NET Core 3.1 构建的 Web API 项目，该项目不仅实现了标准的 RESTful 接口服务，还额外集成了“Views”功能，表明...
.NetCore WebApi 3.1 Swagger建立流程
weixin_42046939的博客
01-15 717
第一步 第二步 第三步 第四步 第五步 第六步 安装成功后可以在依赖库中知找到： 第七步 第八步 “launchUrl”: “swagger/index.html”, 第九步 在代码里加上注释 结果： ...
Asp.Net Core 3.1 WebApi 实现前后端分离，实现文件上传下载【02源码】
09-24
架构设计：ASP.Net Core 3.1 WebApi+Swagger+Jwt+Autofac。 分享初衷：最近在做前后端分离项目，用到了文件上传下载功能，找了很多类似的案例，基本上都是相互转载，很少有原创的(总之找了很久没找到合适的)，最后没有达到我想要的预期效果，故写此篇博客。 需求背景：以前在做文件上传下载，都是基于FrameWork项目或者Core Web项目实现的文件上传或下载，基于web的文件下载及权限比较好实现的。但是现在很多公司技术领导层，都在推行前后端分离理念，所以这一次我承担了Core Api 架构设计，采用的是Vue+Core 3.1 WebApi去实现前后端分离. 实现效果图：https://blog.csdn.net/qq_15632461/article/details/108626802
ASP.NET Core根据环境变量支持多个 appsettings.json配置文件
10-14
主要介绍了ASP.NET Core根据环境变量支持多个 appsettings.json配置文件，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
.netcore 3.1高性能微服务架构：加入swagger接口文档
沐雪架构师
02-22 1128
swagger是什么？ Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。 swagger作用 (1)接口的文档在线自动生成。 (2)功能测试。 接口开发的痛点 相信无...
在.NetCore Api 中使用 Swagger
懂就答的博客
06-30 605
一、新建.netCore webapi项目 二、安装swagger ，通过 Package Manager 控制台：Install-Package SwashBuckle.AspNetCore -Pre 三、修改Startup.cs public void ConfigureServices(IServiceCollection services) { services.AddSwaggerGen(c => .
学习IdentityServer4的预备知识
li123128的博客
06-23 2984
　　要学习IdentityServer，事先得了解一下基于Token的验证体系，这是一个庞大的主题，涉及到Token，OAuth&OpenID，JWT，协议规范等等等等，园子里已经有很多介绍的文章了，个人觉得solenovex的这一篇文章《学习IdentityServer4的预备知识》言简意赅，可以快速的看看。　　重点关注一下上面这张图（也是来自solenovex的文章），对于一个User...
【从零开始搭建自己的.NET Core Api框架】（一）创建项目并集成swagger：1.2 swagger的高级应用...
weixin_30593443的博客
06-23 515
系列目录 一. 创建项目并集成swagger 　　1.1 创建 　　1.2 完善 二.搭建项目整体架构 三. 集成轻量级ORM框架——SqlSugar 　　3.1 搭建环境 　　3.2 实战篇：利用SqlSugar快速实现CRUD 　　3.3 生成实体类 四. 集成JWT授权验证 前一章我们在项目中初步集成了swagger插件，但是还有一些问题需要解决...
.net core 获取项目路径
dengweituo2669的博客
07-20 2141
var basePath = PlatformServices.Default.Application.ApplicationBasePath;var basePath = Microsoft.DotNet.PlatformAbstractions.ApplicationEnvironment.ApplicationBasePath; 转载于:https://www.cnblogs....
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值