swagger

=============================================== 2020/1/8_第1次修改 ccb_warlock =============================================== swagger作为Asp .Net的接口文档已经应用于当前系统一段时间了，比起开个postman填参数请求来说这个后台开发可以直接用swagger来快速测试接口的业务，前端开发通过查看swagger可以快速了解后台API的输入输出（毕竟开发进度紧张的情况下不可能来得及及时维护文档，但是开发环境的swagger只要代码更新就会一起更新） 最近为了试验EF Core 2.2的datetime类型存在的一个缺陷，公司也没有1个.net core 3.0以上的项目，没办法只有先改造.net core 2.2的项目到.net core 3.1以后，再进行下一步测试。 在做框架升级的时候，不得不实现swagger升级的问题。而swagger的升级问题花了点时间来处理，所以记录下过程方便以后查看。 现在的稳定版还不支持.net core 3.0+，所以Nuget里需要升级下面2个项目到5.0.0以上的预览版才能实现swagger的升级。 Swashbuckle.AspNetCore（ 勾选上预发行，当前要v5.0.0-rc5以上版本 ）

Maven依赖 < ! -- swagger api -- > < dependency > < groupId > io . springfox < / groupId > < artifactId > springfox - swagger2 < / artifactId > < version > 2.9 .2 < / version > < / dependency > < dependency > < groupId > io . springfox < / groupId > < artifactId > springfox - swagger - ui < / artifactId > < version > 2.9 .2 < / version > < / dependency > Docket配置 package org . sang . config ; import org . springframework . beans . factory . annotation . Value ; import org . springframework . context . annotation . Bean ; import org . springframework . context . annotation . Configuration ; import

【推荐】2019 Java 开发者跳槽指南.pdf(吐血整理) >>> SpringBoot2中，怎么生成静态文档 在实际开发过程中，我们通过swagger就可以生成我们的接口文档，这个文档就可以提供给前端人员开发使用的。但是，有时候，我们需要把我们的接口文档，提供给第三方合作公司怎么办？ 本人现在就遇到这个问题。我们的项目开发完成之后，也是前后端分离的模式。但是，第三方公司需要我们的接口文档，怎么办？那就需要我们把swagger的文档，生成静态文档才可以发送过去。 接口文档 说起来接口文档，大家最熟悉的就是swaggger了吧。这个可以很方便的可以注解的方式，就可以生成我们需要的文档。而且可以在线调试接口。 随着前后端分离架构和微服务架构的流行，我们使用Spring Boot来构建RESTful API项目的场景越来越多。通常我们的一个RESTful API就有可能要服务于多个不同的开发人员或开发团队：IOS开发、Android开发、Web开发甚至其他的后端服务等。 上面就是项目启动之后，swagger给我们提供的可视化界面了。 swagger项目集成 springboot中集成swagger很简单，只需要我们导入依赖，然后在方法上写上注解就可以了。 应用主类中添加 @EnableSwagger2Doc 注解，具体如下 根据项目需要，我们可以修改swagger的默认配置

Linux shell 编程 java JVM 调优常用CMD Spring下的文档自动生成工具--swagger Mongo跑数据杂记 storm 启动关闭脚本 各种cmd, java related, cpu High 便捷的Centos上自用vpn搭建-pptp MySql数据库使用中常见操作命令简单记录 Maven java程序打包插件 大专栏 出错啦！ ref="/http-connection" class="title">从Apache PoolingHttpClientConnectionManager看连接 从SpringBoot观察tomcat MySql常用函数积累 MyBatis insert Statement的常用办法 Maven非仓库JAR的引入打包并使用的方法 java 分层设计对象模型--POJO(VO/DTO/DO/BO) 各种java框架文档链接 Maven常用命令操作积累 chrome postman0.8.4安装 来源： https://www.cnblogs.com/lijianming180/p/12147570.html

安装NuGet 程序包=》Swashbuckle.AspNetCore 在 Startup.ConfigureServices 方法里添加注册生成器 1 //注册Swagger生成器，定义一个和多个Swagger 文档 2 services.AddSwaggerGen(c => 3 { 4 c.SwaggerDoc("v1", new Info() { Title = "测试版本", Version = "v1" }); 5 6 c.ResolveConflictingActions(apiDescriptions => apiDescriptions.First()); 7 c.CustomSchemaIds(type => type.FullName); // 解决相同类名会报错的问题 8 9 c.IncludeXmlComments(Path.Combine(Directory.GetCurrentDirectory(), "SwaggerDemo.xml")); // 注释要使用的 XML 文档 10 }); 如果需要使用到在页面显示控制器的一些注释，可选择生成-输出-XML文档文件。 1591可免去一些没有加注释的一些警告。 注释实例： ---- 在 Startup.Configure 方法里添加中间件服务 //启用中间件服务生成Swagger作为JSON终结点 app

一.创建WebApi项目： 生成项目之后，控制器默认生成了一个WeatherForecastController 我们可以直接启动项目，F5调试，默认进入WeatherForecastController控制器，结果： 到这里最原始的webapi环境已经配置好了！ 二.配置Swagger插件 插件可以从去swagger官网或github上下载源码，然后将源码（一个类库）引入自己的项目；也可以直接利用NuGet包添加程序集应用。这里我们选择第二种 在弹出的页面中，搜索“Swashbuckle.AspNetCore”，（如果解决方案里有多个类库，只需要勾选主项目，也就是包含控制器的项目），点击安装（ 注意事项：我这里用的环境是.netcore 3.0 所以在选择包的时候一定要勾选包括预发行版，5.0.0-rc5 ） 安装完之后在项目的依赖项里看下是否安装成功。 这时如果运行调试，在域名后面输入/swagger，会发现swagger还没有起作用，因为还没有在项目的启动项里添加swagger服务。 添加swagger 配置： 打开Startup.cs类，编辑ConfigureServices类（区别于.netcore 2.0） public void ConfigureServices(IServiceCollection services) { services

项目中你可能已经使用到了swagger，或许你并没有对它过于留意，比如说springfox、swagger-springmvc、swagger-ui他们之间的关系是什么，springfox原理是什么。 先看一个pull下来就能启动的spring-boot，swagger-ui集成demo git项目地址 https://github.com/moxingwang/swagger.git 获取代码 git pull https://github.com/moxingwang/swagger.git 启动 cd swagger mvn spring-boot:run 访问 http://localhost:8080/sw/swagger-ui.html 自此一个非常方便又简单的swagger-ui集成好了，写完业务逻辑代码可以立马公布restful api给前端调用。 具体使用 基于springfox使用swagger非常简单，只需要maven依赖以及少量config配置就可以实现，上面的demo中都有体现，或者直接访问springfox的github上面的demo springfox/springfox-demos 。 springfox更详细配置请参考官方文档 Springfox Reference Documentation 。 swagger annotation具体使用

Spring Boot项目中常使用springfox-swagger来生成REST API文档，使用springfox-swagger-ui进行API测试。 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.8.0</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.8.0</version> </dependency> REST API方法的参数含有org.springframework.data.domain.Pageable时，如未进行其它配置，Swagger根据接口Pageable的get/is方法生成了pageNumber、pageSize、offset、paged、unpaged、sort.sorted、sort.unsorted等参数，但实际上这些参数是无效的。 @ApiOperation(value = "Find airlines") @GetMapping(value = "/airlines") public

1.创建spring boot项目 2.导入jar <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.9.2</version> </dependency> <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> 3.编写一个Hello 工程 4.配置swagger ==>Config @Configuration br/>@EnableSwagger2//开启swagger2 public class SwaggerConfig { } 5.测试运行: http://127.0.0.1:8080/swagger-ui.html