SpringBoot之集成swagger2
maven配置
<dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>2.5.0</version> </dependency> <dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger-ui</artifactId><version>2.5.0</version> </dependency>
增加Swagger2Config.java配置文件
package com.zns.config;import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import springfox.documentation.builders.ApiInfoBuilder; import springfox.documentation.builders.PathSelectors; import springfox.documentation.builders.RequestHandlerSelectors; import springfox.documentation.service.ApiInfo; import springfox.documentation.service.Contact; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; import springfox.documentation.swagger2.annotations.EnableSwagger2;@Configuration @EnableSwagger2 public class Swagger2Config {//是否线上环境 可以通过文件配置是否线上环境 此处直接写死private Boolean isOnLineFlag = false;@Beanpublic Docket createRestApi() {if (isOnLineFlag) {return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfoOnline()).select().paths(PathSelectors.none())//如果是线上环境,添加路径过滤,设置为全部都不符合 .build();} else {return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.basePackage("com.zns")).paths(PathSelectors.any()).build();}}private ApiInfo apiInfo() {return new ApiInfoBuilder()//页面标题.title("Spring Boot 测试使用 Swagger2 构建RESTful API")//创建人.contact(new Contact("xxx", "http://www.xxx.com", ""))//版本号.version("1.0")//描述.description("API 描述").build();}private ApiInfo apiInfoOnline() {return new ApiInfoBuilder().title("").description("").license("").licenseUrl("").termsOfServiceUrl("").version("").contact(new Contact("", "", "")).build();} }
增加StudentController测试
package com.zns.controller;import io.swagger.annotations.Api; import io.swagger.annotations.ApiImplicitParam; import io.swagger.annotations.ApiImplicitParams; import io.swagger.annotations.ApiOperation; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RequestMethod; import org.springframework.web.bind.annotation.RestController;@Api(value = "student", description = "学生", tags = {"Student"}) @RestController public class StudentController {@ApiOperation(value = "根据id查询学生信息", notes = "根据id查询学生信息")@ApiImplicitParams({@ApiImplicitParam(name = "id", value = "学生ID", defaultValue = "1", required = true, dataType = "Integer")})@RequestMapping(value = "/get", method = RequestMethod.POST)public Object get(Integer id) {return "xxx";} }
启动项目访问接口文档
http://localhost:8080/swagger-ui.html
转载于:https://www.cnblogs.com/zengnansheng/p/10389819.html
SpringBoot之集成swagger2相关推荐
- SpringBoot集成Swagger2、Swagger2和Swagger3的区别Swagger的注解学习
Swagger的介绍 Swagger 是一个规范和完整的框架,用于生成.描述.调用和可视化 RESTful 风格的 Web 服务.总体目标是使客户端和文件系统作为服务器以同样的速度来更新. 随着前后端 ...
- springboot集成swagger2测试接口
springboot集成swagger2测试接口 1.需要的依赖 2.开始编写一个swagger2 3.演示效果图片 1.需要的依赖 <dependency><groupId> ...
- springboot集成swagger2多模块中文配置详细步骤,解决集成mybatis或mybatis-plus无法正常使用问题
springboot集成swagger2多模块中文配置详细步骤,解决集成mybatis或mybatis-plus无法正常使用问题 参考文章: (1)springboot集成swagger2多模块中文配 ...
- 13.9 SpringBoot集成Swagger2中遇到的问题
13.9 SpringBoot集成Swagger2中遇到的问题 我们在使用SpringBoot集成Swagger2中,访问:http://127.0.0.1:8188/swagger-ui.html ...
- springboot集成swagger2构建RESTful API文档
在开发过程中,有时候我们需要不停的测试接口,自测,或者交由测试测试接口,我们需要构建一个文档,都是单独写,太麻烦了,现在使用springboot集成swagger2来构建RESTful API文档,可 ...
- springboot集成swagger2,构建优雅的Restful API
springboot集成swagger2,构建优雅的Restful API 转载请标明出处: 原文首发于:https://www.fangzhipeng.com/springboot/2017/07/ ...
- SpringBoot集成Swagger2自动生成友好的RestApi测试页面及文档
springBoot集成swagger2 水煮鱼又失败了 https://www.jianshu.com/p/002ce2f26103 1 背景 springBoot作为微服务首选框架,为其他服务提供 ...
- 【快速上手系列】使用Springboot集成Swagger2的简单使用测试
[快速上手系列]使用Springboot集成Swagger2的简单使用测试 简介 Swagger2是为了解决企业中接口(api)中定义统一标准规范的文档生成工具. 尤其是前后端分离时对一些业务接口也不 ...
- SpringBoot集成Swagger2
SpringBoot集成Swagger2 刚开始用2.0.2.RELEASE版本的SpringBoot去继承2.7.0版本的springfox-swagger2一直出现请求下面这种情况,就是在启动Sp ...
最新文章
- 视觉slam重点知识笔记
- 不要仅仅依靠单元测试
- 找出js里面改变cookies的代码
- android指南针校准 代码_Android 指南针传感器
- Boltzmann 玻尔兹曼机(BM)
- Evernote CEO给想做长久公司创业者的3个建议
- ftp java 关闭连接超时_关于FTP连接超时的解决办法
- python123平台怎么上课_国内优秀的Python教学平台推荐-python123.io
- 【20CSPS提高组】题解
- 变量名和变量地址之间的关系
- “体验版”PyTorch 2.0备受瞩目,它到底好在哪里?
- C# 添加PDF页眉/页脚
- R语言威尔科克森符号秩和(Wilcoxon Signed Rank statistic)分布
- 表单注册表单注册表单注册
- 小方块上升组成背景特效 html+css+js
- Bluecms代码审计
- ANSYS Workbench18.0有限元仿真分析视频教程
- python预测体彩大乐透
- 5G SA and NSA
- python图片截取特定部分_如何在Python中使用OpenCV提取图像的特定部分?
热门文章
- C++11中std::initializer_list的使用
- 加班到凌晨三点,就能月薪五万了吗?
- java英文字符编码_Java邮件编码非英文字符
- 卡顿严重_魔兽怀旧服:安其拉开门二测结果出炉,暴雪依然无法解决卡顿问题...
- python 协程和异步的关系_python协程与异步协程
- mysql 账户管理_如何用MySQL 命令来实现账户管理
- linux 编译mqtt静态库_编译MQTT C++ Client
- fabric 启动peer_编写 Fabric 链码的一般准则
- jQuery绑定事件的三种常见方式(bind、one、【change、click、keydown、hover】)
- HTML引用公共组件