Swagger UI

本文将一步步演示如何用swagger美化WebApi接口文档，为接口文档添加接口名称说明，为请求参数和返回数据结构字段含义添加注释说明 一、为WebApi项目安装Swagger 首先我们新建一个WebApi项目 图1（新建WebApi项目） 右击项目，选择管理NuGet程序包,搜索swagger，为WebApi安装swagger 图2（右击项目或者解决方案，选择管理NuGet程序包） 图2（在管理NuGet程序包中搜索Swagger） Swagger安装成功后，App_Start目录会多出一个SwaggerConfig.cs文件 修改HomeController中的Index 运行项目，出现如下图，说明Swagger安装成功 二，为接口添加请求参数字段说明 新建一个类库，用于存放WebApi请求和响应相关模型，并在WebApi中添加对该类库引用 右击WebApiModel项目属性-->生成，勾选XML文档文件,为WebApiModel生成项目Xml文档 在WebApiModel中新增LoginModel类 using System; using System.Collections.Generic; using System.ComponentModel; using System.Linq; using System.Text; using System.Threading

在上一章节中，我们创建了基本的框架结构： https://www.cnblogs.com/fuyu-blog/p/12217647.html 下面我们测试接口和集成Swagger接口文档 一、接口测试 在默认创建的API中，大大和2.2不一样的是给了一个默认的接口示例，但不是Values了，变成了一个天气预报，【为什么呢~~~】 好吧，不管是Values还是天气预报，只要能运行起来，就是好大大 在Api项目右击，点击选择运行，或者在工具栏，点击运行-启动而不调试 自动会打开浏览器，运行成功 下一步，我们自己新建的接口测试一下 在API项目中，Controller文件夹，右击新建文件 选择ASP.NET Core ——Web Api控制器类，输入一个自己写的名字，点击新建按钮 这样一个简单的接口测试类就生成了 生成项目F6 输入测试地址： https://localhost:5001/api/values 访问成功 二、集成Swagger接口文档 在FytSoa.Api项目右击依赖项中，选择管理nuget包，并搜索Swashbuckle.AspNetCore包添加至引用 添加成功 在 Startup 类中 添加并配置 Swagger 中间件 public void ConfigureServices(IServiceCollection services) { services

说明 Swagger是一个WebAPI在线注解、调试插件，过去我们主要通过手工撰写WebAPI接口的交互文档供前端开发人员或外部开发者， 官网地址： https://swagger.io/ 。 但是在实际工作中，往往咋们的文档工作通常落后于实际的环境，导致文档和实际接口不一致，前后端开发人员苦不堪言。 Swagger的出现解放了接口文档撰写的麻烦也提高了前后端开发者的工作效率，所谓“工欲善其事,必先利其器 ”。现在让咋们 了解下在.NET Core 2.1下如何实现Swagger。 1、Nuget安装依赖包 首先Nuget安装Swashbuckle.AspNetCore 打开Nuget控制台(程序包管理控制台)，键入下列命令 Install-Package Swashbuckle.AspNetCore 2、添加Swagger中间件 public IServiceProvider ConfigureServices(IServiceCollection services) { services.Configure<CookiePolicyOptions>(options => { // This lambda determines whether user consent for non-essential cookies is needed for a given request.

先打开netcore官网查看swagger接入文档，路径：netcore 官网 那就跟着官网一步一步来吧 首先建立一个.netcore3.1的webapi，这个就不演示了。 从官网上可以看到最简单的引入swaager的步骤如下： 1、引入最新版的swaager Install-Package Swashbuckle.AspNetCore -Version 5.0 . 0 -rc4 2、在startup类中的 ConfigureServices 方法中的服务集合中添加如下代码 // Register the Swagger generator, defining 1 or more Swagger documents services.AddSwaggerGen(c => { c.SwaggerDoc( " v1 " , new OpenApiInfo { Title = " My API " , Version = " v1 " }); }); 3、 在startup类中的 Configure 方法中 启用中间件为生成的 JSON 文档和 Swagger UI 提供服务 // Enable middleware to serve generated Swagger as a JSON endpoint. app.UseSwagger(); // Enable middleware

一.概述 　　在使用Web API时，对于开发人员来说，了解其各种方法可能是一项挑战。在ASP.NET Core上，Web api 辅助工具介绍二个中间件，包括：Swashbuckle和NSwag .NET。本篇先讲Swashbuckle。二者都使用Swagger规范，Swagger也称为OpenAPI， 解决了为Web API生成有用文档和帮助页面的问题。它提供了诸如交互式文档，客户端SDK生成和API可发现性等好处 。 　　(1) Swashbuckle.AspNetCore是一个开源项目，用于为ASP.NET Core Web API生成Swagger文档。 　　(2) NSwag是另一个开源项目，该项目将Swashbuckle和AutoRest（客户端生成）的功能集成在一个工具链中。用于生成Swagger文档并将Swagger UI或ReDoc集成到ASP.NET Core Web API中。此外，NSwag还提供了为API生成C＃和TypeScript客户端代码的方法。 　　 　　 1.1 什么是Swagger / OpenAPI 　　　　 Swagger是一种与开发语言无关的规范，用于描述REST API。Swagger项目被捐赠给OpenAPI计划，现在称为OpenAPI。两个名称可互换使用; 但是，OpenAPI是首选。它允许计算机和IT人理解服务的功能

一直很好奇专门写接口同事的工作，于是趁着手边工作中的闲暇时间，特地看看神奇的接口文档怎么摆弄。 总览： 这是基于thinkjs(3.0)，使用swagger editor编写，实现功能性测试的接口文档。 先了解一些必要的知识吧： 1.）什么是Swagger？ Swagger 是一款RESTFUL接口的文档在线自动生成+功能测试功能软件；是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。Swagger 让部署管理和使用功能强大的API从未如此简单。（ https://swagger.io/ ） Swagger的目标是为REST APIs 定义一个标准的，与语言无关的接口，使人和计算机在看不到源码或者看不到文档或者不能通过网络流量检测的情况下能发现和理解各种服务的功能。当服务通过Swagger定义，消费者就能与远程的服务互动通过少量的实现逻辑。类似于低级编程接口，Swagger去掉了调用服务时的很多猜测。 2.）Swagger Editor 可以直接使用在线编辑器 https://editor.swagger.io/ （左边编辑，右边实时效果），方便我们直接写文档，并将其转成所需的json或者yaml格式。 3.

为什么用swagger2？swagger1和2试用对比 在springMVC项目中引入swagger2 springfox与swagger的关系 对第2步配置的说明 1.为什么用swagger2?swagger1和2试用对比 试用过swagger-springmvc和springfox-swagger2后，为了能限定暴露哪些接口，选用swagger2。 swagger2的引入更加轻量化：依赖关系+swagger2配置文件+@Api注解搞定，不必像swagger-springmvc还需要单独引入页面显示包。 通过swagger2提供的Docket类，可以更多的控制api文档的生成。 2.在springMVC项目中引入swagger2 1.配置依赖关系 pom.xml <!-- swagger2 --> < dependency > < groupId > io.springfox </ groupId > < artifactId > springfox-swagger2 </ artifactId > < version > 2.6.1 </ version > </ dependency > < dependency > < groupId > io.springfox </ groupId > < artifactId > springfox-swagger-ui </

　　前言：我们开发了很多的接口后，为了方便调用人员使用，需要给出接口地址，参数和解释说明，可能还需要示例。 那么swagger这个开源项目，已经给我们提供好了一整套的解决方案： 　　本博客参考文档： 　　 Swashbuckle 和 ASP.NET Core 入门 　　 　　什么是 Swagger/OpenAPI？ Swagger 是一个与语言无关的规范，用于描述 REST API。 Swagger 项目已捐赠给 OpenAPI 计划 ，现在它被称为开放 API。 这两个名称可互换使用，但 OpenAPI 是首选。 它允许计算机和人员了解服务的功能，而无需直接访问实现（源代码、网络访问、文档）。 其中一个目标是尽量减少连接取消关联的服务所需的工作量。 另一个目标是减少准确记录服务所需的时间。（说明参考微软官方文档： https://docs.microsoft.com/zh-cn/aspnet/core/tutorials/web-api-help-pages-using-swagger?view=aspnetcore-3.0 ） 　　快速添加webapi项目对swagger的支持： 　　 1-添加程序包引用：Swashbuckle.AspNetCore -Version 5.0. 0-rc4 (该版本目前属于预览版，需要勾选预览版才可以看到) 　 2- 添加并配置 Swagger

一、安装swagger 　　新建一个net core的api项目，通过NuGet安装Swashbuckle.AspNetCore。 二、注册swagger服务 　　在Startup.cs中注册Swagger生成器。 public void ConfigureServices(IServiceCollection services) { services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2); // 注册Swagger生成器，定义一个和多个Swagger 文档 #region Swagger services.AddSwaggerGen(options => { options.SwaggerDoc( " v1 " , new Info { Title = " My API " , Version = " v1 " }); }); #endregion } 　　启用Swagger。 public void Configure(IApplicationBuilder app, IHostingEnvironment env) { if (env.IsDevelopment()) { app.UseDeveloperExceptionPage(); } else { app.UseHsts()

本人使用的是ABP netcore +Swagger环境。 在这之前，网上搜索到的解决方案都没有解决我的问题，swaggerUI上IFromFile内部的属性都展示到swagger上了。 网上解决的方法大同小异，在这就贴一篇作为比较http://www.cnblogs.com/intotf/p/10075162.html 使用效果前： 使用后效果： 话不多说，直接上代码 Swagger选项过滤器代码 using Microsoft.AspNetCore.Http; using Swashbuckle.AspNetCore.Swagger; using Swashbuckle.AspNetCore.SwaggerGen; using System; using System.Collections.Generic; using System.Linq; using System.Reflection; using System.Threading.Tasks; namespace ZGBPurchase.Web.Host { public class SwaggerFileUploadFilter : IOperationFilter { private static readonly string[] FormFilePropertyNames = typeof(IFormFile