如何通过注解方式给项目添加Swagger功能
在Java后端,每次开发一个新的接口后需要自测,此时可以借助Swagger功能很好地完成自测,下面将通过注解的方式来添加Swagger。
(1)代码部分
- package com.bien.edge;
- import java.util.ArrayList;
- import java.util.List;
- import org.springframework.context.annotation.Bean;
- import org.springframework.context.annotation.Configuration;
- import springfox.documentation.builders.ApiInfoBuilder;
- import springfox.documentation.builders.ParameterBuilder;
- import springfox.documentation.builders.PathSelectors;
- import springfox.documentation.builders.RequestHandlerSelectors;
- import springfox.documentation.schema.ModelRef;
- import springfox.documentation.service.ApiInfo;
- import springfox.documentation.service.Parameter;
- import springfox.documentation.spi.DocumentationType;
- import springfox.documentation.spring.web.plugins.Docket;
- import springfox.documentation.swagger2.annotations.EnableSwagger2;
- @Configuration
- @EnableSwagger2
- public class Swagger2 {
- @Bean
- public Docket createRestApi() {
- ParameterBuilder userid = new ParameterBuilder();
- ParameterBuilder username = new ParameterBuilder();
- ParameterBuilder lang = new ParameterBuilder();
- List<Parameter> pars = new ArrayList<Parameter>();
- // 添加默认请求头
- userid.name("X-Person-No").description("人员号码").modelRef(new ModelRef("string")).parameterType("header").required(false);
- username.name("X-Person-Name").description("人员姓名").modelRef(new ModelRef("string")).parameterType("header").required(false);
- lang.name("X-Lang-Id").description("语言标准编码").modelRef(new ModelRef("string")).parameterType("header").required(false).defaultValue("zh_CN");
- pars.add(userid.build());
- pars.add(username.build());
- pars.add(lang.build());
- return new Docket(DocumentationType.SWAGGER_2)
- .apiInfo(apiInfo())
- .select()
- .apis(RequestHandlerSelectors.basePackage("com.bien.edge"))
- .paths(PathSelectors.any())
- .build().globalOperationParameters(pars);
- }
- private ApiInfo apiInfo() {
- return new ApiInfoBuilder()
- .title("Bien94Edge项目API可视化")
- .description("Bien94Edge项目API可视化相关接口")
- .version("1.0")
- .build();
- }
- }
(2)配置部分
在application.yml文件中配置swagger的api访问方式,如下图所示:
其实,也可以不用配置这些属性的,默认是api-docs,当前path值也可以设置为其它值,只要不与工程中其它路径冲突即可,也就是说保持唯一性即可。
默认时,链接类似于这样的:http://localhost:1994/bien-edge/v2/api-docs
若path设置为/swagger.json时,链接类似于这样的: http://localhost:1994/bien-edge/swagger.json
若path设置为/swaggerbien时,链接类似于这样的: http://localhost:1994/bien-edge/swaggerbien
(3)效果部分
上图是运行swagger后展示的一些相关说明信息,在上述代码中apiInfo()函数进行设置即可。
上图所展示的是每个接口的默认请求头信息,可以根据需要进行添加,并且还可以设置必须和非必须属性。
到此,项目中的Swagger功能添加完毕,是不是很简单呀。^-^
(4)其它
当访问swagger时,会有如下这些servlet path:
- /
- /swager-ui.html
- /swagger-resources
- /swagger-resources/configuration/ui
- /swagger-resources/configuration
- /swagger-resources/configuration/security
- /error
- /csrf
- /webjars/springfox-swagger-ui/fonts/source-code-pro-v7-latin-600.woff2
- /webjars/springfox-swagger-ui/fonts/titillium-web-v6-latin-regular.woff2
- /webjars/springfox-swagger-ui/swagger-ui-bundle.js
- /webjars/springfox-swagger-ui/springfox.js
- /webjars/springfox-swagger-ui/swagger-ui.css
- /webjars/springfox-swagger-ui/swagger-ui-standalone-preset.js
- /webjars/springfox-swagger-ui/springfox.css
- /webjars/springfox-swagger-ui/favicon-32x32.png
- /webjars/springfox-swagger-ui/favicon-16x16.png
若是后端API添加了拦截器,那么访问swagger的时候可能会访问不了,此时就需要在拦截器中排除swagger的路径就可以正常访问了。只要排除这三个路径就可以了:/swagger-ui.html、/swagger-resources/**和/webjars/springfox-swagger-ui/**
------20191231闪
如何通过注解方式给项目添加Swagger功能的更多相关文章
- 关于springMVC3.0基于注解方式的项目搭建
前言:开发了几个月的AS3项目,感觉JAVA都用不太熟练了.刚好这几个抽的空,就把自己以前用过的Spring框架再搭一边, 并完整的记录下来 开发环境:tomcat + mysql+ java 1.所 ...
- .Net Core项目添加日志功能
一.微软内置的日志组件 在.Net Core中使用模板新建的Web Api项目时,会自动加入日志功能.只需要在控制器中注入ILogger就可以了.命名空间为:Microsoft.Extensions. ...
- 由ASP.NET Core WebApi添加Swagger报错引发的探究
缘起 在使用ASP.NET Core进行WebApi项目开发的时候,相信很多人都会使用Swagger作为接口文档呈现工具.相信大家也用过或者了解过Swagger,这里咱们就不过多的介绍了.本篇文章记录 ...
- WPF|快速添加新手引导功能(支持MVVM)
阅读导航 前言 案例一 案例二 案例三(本文介绍的方式) 如何使用? 控件如何开发的? 总结 1. 前言 案例一 站长分享过 眾尋 大佬的一篇 WPF 简易新手引导 一文,新手引导的效果挺不错的,如下 ...
- 基于已构建S2SH项目配置全注解方式简化配置文件
如果还不熟悉s2sh项目搭建的朋友可以先阅读 eclipse环境下基于tomcat-7.0.82构建struts2项目 eclipse环境下基于已构建struts2项目整合spring+hiberna ...
- springmvc 用注解方式添加事务不生效解决方法
springmvc 事务注册有很多种方法,在此我只mark 用注解方式添加transaction不生效的解决办法. springmvc 注解方法添加事务步骤: 1.在 spring的 root-con ...
- MyBatis通过注解方式批量添加、修改、删除
唯能极于情,故能极于剑 注: 本文转载于:CodeCow · 程序牛 的个人博客:http://www.codecow.cn/ 一.数据库实体DO public class User implemen ...
- Spring学习5-Spring整合JDBC及其事务处理(注解方式)
一.整合的步骤 1.步骤一:首先要获得DataSource连接池(推荐使用B方式): 要对数据库执行任何的JDBC操作,需要有一个Connection.在Spring中,Connection对象是 ...
- Spring学习4-面向切面(AOP)之aspectj注解方式
一.简介 1.AOP用在哪些方面:AOP能够将那些与业务无关,却为业务模块所共同调用的逻辑或责任,例如事务处理.日志管理.权限控制,异常处理等,封装起来,便于减少系统的重复代码,降低模块间的耦合 ...
随机推荐
- Navicat 导入数据时报Incorrect datetime value: '0000-00-00 00:00:00.000000' 错误
今天重装了个系统,装好MySQL和Navicat之后导入SQL时报了Incorrect datetime value: '0000-00-00 00:00:00.000000' 错误, 查了资料说是m ...
- PWA(Progressive web apps),渐进式 Web 应用
学习博客:https://www.jianshu.com/p/098af61bbe04 学习博客:https://www.zhihu.com/question/59108831 官方文档:https: ...
- vue路由--命名视图
有时候想同时(同级)展示多个视图,而不是嵌套展示,例如创建一个布局,有 sidebar(侧导航) 和 main(主内容) 两个视图,这个时候命名视图就派上用场了.你可以在界面中拥有多个单独命名的视图, ...
- JS杨辉三角形
题目:打印出杨辉三角形(要求打印出10行如下图) 1 1 1 1 2 1 1 3 3 1 1 4 6 4 1 1 5 10 10 5 1 分析: 1.第1列或列数=行数时,value=1 2.其余的值 ...
- C#设计模式学习笔记:(20)职责链模式
本笔记摘抄自:https://www.cnblogs.com/PatrickLiu/p/8109100.html,记录一下学习过程以备后续查用. 一.引言 今天我们要讲行为型设计模式的第八个模式--职 ...
- WebSocket以及socketIO的使用
简介 WebSocket 使得客户端和服务器之间的数据交换变得更加简单,允许服务端主动向客户端推送数据.在 WebSocket API 中,浏览器和服务器只需要完成一次握手,两者之间就直接可以创建持久 ...
- 【算法】蓝桥杯 试题 基础练习 Huffuman树
资源限制 时间限制:1.0s 内存限制:512.0MB 问题描述 Huffman树在编码中有着广泛的应用.在这里,我们只关心Huffman树的构造过程. 给出一列数{pi}={p0, p1, …, ...
- 基于S2SH开发学生考勤管理系统 附源码
开发环境: Windows操作系统开发工具:Eclipse+Jdk+Tomcat+mysql数据库 运行效果图 源码及原文链接:http://javadao.xyz/forum.php?mod=vie ...
- 就不能换DB吗? 抽象工厂模式
15.1 就不能换DB吗? 15.2 最基本的数据访问程序 namespace 抽象工厂模式 { class Program { static void Main(string[] args) { U ...
- echarts--可拖动的曲线图
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8&quo ...