谈谈如何在 .net Core 3.1 WebAPI项目中配置Swagger在线接口文档

前言

与往常一样,喜欢在前言中写关于文章转载或者写下的原因。近日,在做基于钉钉接口的二次开发,从前喜欢pc端的web应用,突然转到移动端的开发时突然发现知识不够用,特别是关于web api这块。前后端分离是局势,在习惯了MVC的代码书写形式时,转到去写前端接口变得无法是从。但是就是在这样的环境逼迫下,我们才不断的去积累新的知识,不断加深自己的功力。

下面进入正题

在.netCore中,我们可以使用Swagger插件来管理接口,这样我们的接口文档就能够实时更新了,可以避免文档接口跟不上代码的问题。也可以让前后端的开发人员同时进行开发,提高工作效率。

这篇文章主要是如何在.netCore的API项目环境下配置Swagger接口文档插件的。

首先我们需要安装Swagger的Nuget程序包。这个程序包可以在Nuget管理器中搜索下载。也可以在控制台中通过命令下载,本次例子中我使用的是5.0版本的,在管理器还没有,所以使用控制台通过命令安装:(5.0通过nuget没有适配.net core 3.1的版本)。

在nuget控制台中输入如下代码

Install-Package Swashbuckle.AspNetCore -Version 5.0.0-rc4

程序包安装好后,我们需要在Startup类中的ConfigureServices方法中注册Swagger插件服务:

services.AddSwaggerGen(m => m.SwaggerDoc("v1", new OpenApiInfo { Title = "Swagger Demo", Version = "v1" }));

服务注册好后,我们需要在Startup类中的Configure方法中使用这个服务,使用的时候我们除了使用Swagger服务的同时还需要使用SwaggerUI服务;

  1. app.UseSwagger();
    app.UseSwaggerUI(m => m.SwaggerEndpoint("/swagger/v1/swagger.json", "Swagger Demo"));

    到了这里有个小坑需要注意一下:使用服务的时候,json路径的那个版本号和上面注册服务的版本号必须一致

配置好后,我们启用一下看看,出现下面这个页面:这是初始化页面自带的调试文档

这个页面不是我们想要的,出现这个原因是我们没有修改launchSettings.json配置文件。

接下来我们需要修改launchSettings.json文件(不知道这个文件的小伙伴搜一下就能找到了

我们需要把WeatherForecast改为swagger的index.html中:

好了,我们再把项目启动一下看看效果,出现的结果如下图:

8.png

至此完成。

  • 0
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
### 回答1: .NET Core 3.1 Web API 项目框架是一个用于构建基于RESTful风格的Web API的开发框架。它是.NET Core平台的一部分,可以运行在多个操作系统上,如Windows、Linux和MacOS。以下是该框架的一些主要特点: 1. 跨平台:.NET Core 3.1 Web API可以在多个操作系统上运行,这为开发人员带来了更大的灵活性和便利性。 2. 高性能:.NET Core是一个高性能的框架,可以处理大量的并发请求。它经过优化,能够提供快速响应时间和较低的资源消耗。 3. 轻量级:相比于传统的.NET框架,.NET Core是一个更轻量级的框架。它采用了模块化体系结构,可以选择性地引用和使用需要的组件,减少了部署包的大小。 4. 开放性:.NET Core 3.1 Web API是一个开放的框架,可以与其他平台和技术进行无缝集成。它支持多种数据格式和协议,如JSON、XML、RESTful和WebSocket等。 5. 高度可扩展:通过使用间件和自定义管道,开发人员可以方便地扩展和定制Web API的功能。它还支持依赖注入和插件机制,使得代码的组织和测试变得更加简单。 6. 安全性:.NET Core 3.1 Web API提供了强大的安全性功能,包括身份验证、授权、访问控制等。它支持常见的认证方案,如基于令牌的身份验证和OAuth。 总之,.NET Core 3.1 Web API是一个现代化、高效且可扩展的框架,适用于构建各种规模的Web API应用程序。它简化了开发过程,提供了丰富的功能和工具,帮助开发人员快速构建高质量的API。 ### 回答2: .NET Core 3.1 Web API项目框架是用于构建基于RESTful风格的Web服务的开发框架。它是在跨平台、高性能和可扩展性方面进行了优化的框架。 .NET Core 3.1是一个开源的、跨平台的框架,可以在Windows、Linux和Mac等多个操作系统上运行。这意味着我们可以使用相同的代码和工具来构建应用程序,无需为不同的操作系统创建额外的代码。 Web API是一种使用HTTP协议提供数据交互的应用程序编程接口。它通过HTTP请求(通常是GET、POST、PUT、DELETE)来处理数据,并返回JSON或XML等数据格式作为响应。Web API是一种通用的服务架构,可以与不同平台上的客户端应用程序进行通信。 在.NET Core 3.1 Web API项目框架,我们可以使用C#来编写API控制器,通过定义不同的API端点和路由来处理不同类型的请求。我们可以使用一些常用的属性(如[HttpGet]、[HttpPost]等)来定义API端点,并使用参数绑定来获取请求的数据。 框架还提供了丰富的间件和插件,以处理身份验证、授权、日志记录等常见的开发需求。我们还可以通过使用依赖注入来管理应用程序的组件和服务。 另外,.NET Core 3.1框架还提供了一些实用的工具和库,例如Entity Framework CoreSwagger等,可以简化数据库访问和API文档生成等任务。 总之,.NET Core 3.1 Web API项目框架是一个强大、灵活和高效的开发框架,可以帮助我们构建出高性能和可靠的Web服务。它具有跨平台的优势,并提供了丰富的功能和工具来简化开发流程。 ### 回答3: .NET Core 3.1是一个跨平台的开发框架,适用于构建不同类型应用的云和互联网解决方案。在.NET Core 3.1WebAPI项目框架也得到了重要的改进和功能增强。 首先,.NET Core 3.1WebAPI项目框架提供了更强大的路由功能,可以使用属性路由来定义API的访问路径,从而更灵活地组织和管理API的接入点。 其次,.NET Core 3.1WebAPI项目框架引入了端点路由的概念,可以根据不同的HTTP方法和路由规则来映射到不同的动作方法,从而实现更细粒度的控制。 此外,.NET Core 3.1WebAPI项目框架还提供了更强大的模型绑定功能,可以将请求的数据自动绑定到动作方法的参数上,大大减少了编写冗余代码的工作量。 在数据序列化方面,.NET Core 3.1WebAPI项目框架支持多种数据格式,包括JSON和XML,可以根据客户端的需求选择合适的数据格式进行传输。 此外,.NET Core 3.1WebAPI项目框架还提供了强大的间件支持,可以实现各种功能,如身份验证、授权、异常处理等,极大地提高了开发效率。 总体来说,.NET Core 3.1WebAPI项目框架在路由、模型绑定、数据序列化和间件方面都得到了重要的改进和增强,为开发者提供了更强大、更灵活的开发工具,使得构建高性能、可扩展的WebAPI应用变得更加简单和方便。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值