Spring Boot 中使用 Swagger2 构建强大的 RESTful API 文档
项目现状:由于前后端分离,没有很好的前后端合作工具。
由于接口众多,并且细节复杂(需要考虑不同的HTTP请求类型、HTTP头部信息、HTTP请求内容等),高质量地创建这份文档本身就是件非常吃力的事,下游的抱怨声不绝于耳。
随着时间推移,不断修改接口实现的时候都必须同步修改接口文档,而文档与代码又处于两个不同的媒介,除非有严格的管理机制,不然很容易导致不一致现象。
为了解决上面这样的问题,本文将介绍RESTful API的重磅好伙伴Swagger2,它可以轻松的整合到Spring Boot中,并与Spring MVC程序配合组织出强大RESTful API文档。它既可以减少我们创建文档的工作量,同时说明内容又整合入实现代码中,让维护文档和修改代码整合为一体,可以让我们在修改代码逻辑的同时方便的修改文档说明。另外Swagger2也提供了强大的页面测试功能来调试每个RESTful API。
添加Swagger2依赖
在pom.xml中加入Swagger2的依赖
1
2
3
4
5
6
7
8
9
10
|
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version> 2.2 . 2 </version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version> 2.2 . 2 </version>
</dependency>
|
创建Swagger2配置类
在Application.java同级创建Swagger2的配置类Swagger2。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
|
@Configuration
@EnableSwagger2
public class Swagger2 {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select() .apis(RequestHandlerSelectors.basePackage(
" ))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title( "Spring Boot中使用Swagger2构建RESTful APIs" )
.description( "更多Spring Boot相关文章请关注:swagger官网" )
.termsOfServiceUrl( "https://swagger.io/" )
.contact( "程序猿DD" )
.version( "1.0" )
.build();
}
}
|
如上代码所示,通过@Configuration注解,让Spring来加载该类配置。再通过@EnableSwagger2注解来启用Swagger2。
测试代码:
package com.bai.controller;import com.bai.domain.User;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.*;import java.util.*;/*** Created by DELL on 2017/7/5.*/
@RestController
@RequestMapping(value = "/users") // 通过这里配置使下面的映射都在/users下,可去除
public class UsersController {static Map<Long, User> users = Collections.synchronizedMap(new HashMap<Long, User>());@ApiOperation(value = "获取用户列表", notes = "")@RequestMapping(value = {""}, method = RequestMethod.GET)public List<User> getUserList() {List<User> r = new ArrayList<User>(users.values());return r;}@ApiOperation(value = "创建用户", notes = "根据User对象创建用户")@ApiImplicitParam(name = "user", value = "用户详细实体user", required = true, dataType = "User")@RequestMapping(value = "", method = RequestMethod.POST)public String postUser(@RequestBody User user) {users.put(user.getId(), user);return "success";}@ApiOperation(value = "获取用户详细信息", notes = "根据url的id来获取用户详细信息")@ApiImplicitParam(name = "id", value = "用户ID", required = true, paramType = "path", dataType = "Long")@RequestMapping(value = "/{id}", method = RequestMethod.GET)public User getUser(@PathVariable Long id) {return users.get(id);}@ApiOperation(value = "更新用户详细信息", notes = "根据url的id来指定更新对象,并根据传过来的user信息来更新用户详细信息")@ApiImplicitParams({@ApiImplicitParam(name = "id", value = "用户ID", required = true, paramType = "path", dataType = "Long"),@ApiImplicitParam(name = "user", value = "用户详细实体user", required = true, dataType = "User")})@RequestMapping(value = "/{id}", method = RequestMethod.PUT)public String putUser(@PathVariable Long id, @RequestBody User user) {User u = users.get(id);u.setUserName(user.getUserName());u.setEmail(user.getEmail());users.put(id, u);return "success";}@ApiOperation(value = "删除用户", notes = "根据url的id来指定删除对象")@ApiImplicitParam(name = "id", value = "用户ID", required = true,paramType="path", dataType = "Long")@RequestMapping(value = "/{id}", method = RequestMethod.DELETE)public String deleteUser(@PathVariable Long id) {users.remove(id);return "success";}
}
完成上述代码添加上,启动Spring Boot程序,访问:http://localhost:8080/swagger-ui.html
。就能看到前文所展示的RESTful API的页面。
转载于:https://www.cnblogs.com/baizhanshi/p/7124575.html
Spring Boot 中使用 Swagger2 构建强大的 RESTful API 文档相关推荐
- Spring Boot中使用Swagger2构建强大的RESTful API文档
由于Spring Boot能够快速开发.便捷部署等特性,相信有很大一部分Spring Boot的用户会用来构建RESTful API.而我们构建RESTful API的目的通常都是由于多终端的原因,这 ...
- Spring Boot中使用Swagger2构建RESTful APIs
关于 Swagger Swagger能成为最受欢迎的REST APIs文档生成工具之一,有以下几个原因: Swagger 可以生成一个具有互动性的API控制台,开发者可以用来快速学习和尝试API. S ...
- java Spring Boot中使用Swagger2构建API文档
1.添加Swagger2的依赖 在pom.xml中加入Swagger2的依赖 <dependency><groupId>io.springfox</groupId> ...
- Spring Boot 2.x基础教程:Swagger静态API文档的生成
点击蓝色"程序猿DD"关注我 回复"资源"获取独家整理的学习资料! 作者 | 翟永超 来源 | didispace.com/spring-boot-learni ...
- Spring Boot 集成Swagger2生成RESTful API文档
Swagger2可以在写代码的同时生成对应的RESTful API文档,方便开发人员参考,另外Swagger2也提供了强大的页面测试功能来调试每个RESTful API. 使用Spring Boot可 ...
- Spring MVC中使用 Swagger2 构建Restful API
0.Spring MVC配置文件中的配置 [java] view plain copy <!-- 设置使用注解的类所在的jar包,只加载controller类 --> <span s ...
- springboot集成swagger2构建RESTful API文档
在开发过程中,有时候我们需要不停的测试接口,自测,或者交由测试测试接口,我们需要构建一个文档,都是单独写,太麻烦了,现在使用springboot集成swagger2来构建RESTful API文档,可 ...
- Spring Boot 集成 Swagger 生成 RESTful API 文档
原文链接: Spring Boot 集成 Swagger 生成 RESTful API 文档 简介 Swagger 官网是这么描述它的:The Best APIs are Built with Swa ...
- Golang 见证 godoc 的强大(生成API文档,打印文档)
Golang 见证 godoc 的强大(生成API文档,打印文档) 文章目录 Golang 见证 godoc 的强大(生成API文档,打印文档) 一.godoc 介绍 二.godoc 安装 ① 系统环 ...
最新文章
- Android自带的emoji表情的使用
- QT 托盘图标退出延迟解决方案
- git放弃本地修改,强制覆盖本地文件
- SonarQube6.2源码解析(三)
- 为女儿示范的两张石膏像素描
- 金昌搜索引擎优化网络推广_网络推广优化企业服务
- 一维数组和二维数组互转
- mybatis快速入门(三)
- 开源阅读_开源如何维持您的阅读习惯
- 奈雪的茶回应违规操作事件:虚心接受意见并及时改进
- Redis:复制,第2部分——主从复制和Redis哨兵
- Java Main Differences between HashMap HashTable and ConcurrentHashMap
- 笔记 - 收藏集 - 掘金
- 西威变频器 服务器显示,西威变频器故障查询及操作方法;
- ps 毛发 边缘_PS技巧:毛发抠图调整边缘法
- html5 保存 搜索历史,前端实现搜索记录功能也就是天猫app历史记录存储方便浏览 - 今天的代码你撸了嘛...
- Pycharm安装、使用的一些操作
- 博图在线升级 gsd_美生在线消费全返张鹏海外大举收割国内韭菜。
- ipad发布会ipad_iPad诞生十周年
- 基于springboot的校园二手交易系统-JAVA【数据库设计、论文、源码、开题报告】
热门文章
- 记录部署hue在k8s上
- Linux下的、1、2、2>1、dev/null黑洞文件
- Linux一些经典书籍
- 2049 : 压死骆驼的最后一根稻草 (规律)
- non-member function ‘size_t capacity()’ cannot have cv-qualifier
- 【c++】为什么类中静态(static)成员不能在类的定义内初始化?
- 实例手册_独家数据 | 1820Fall 香港研究生商科类14个热门专业 1400+申请实例汇总...
- 解决vscode在apt update时哈希冲突问题
- 十大排序算法之快速排序(两种方法)
- [BUUCTF-pwn]——picoctf_2018_can_you_gets_me