Springboot integrates swagger UI to quickly generate online API documents

Tian Qiao Ba Xia 2020-11-08 12:06:25
springboot integrates swagger ui quickly


SpringBoot Integrate Swagger-ui Online API file

Swagger It's a powerful api frame , Support online interface documentation ui Interface , It also provides online testing function , Besides , It also supports popular Restful Style interface .

The main point of this article is

  • Brief introduction restful style .

  • Introduce SpringBoot And Swagger-ui Fast integration .

  • Introduce Swagger-ui Commonly used annotations .

One 、restful Brief introduction to style

REST(Representational State Transfer): Expressive state transfer , It's a way to design and develop web applications , Reduce development complexity , Improve the scalability of the system .

Simply speaking ,HTTP The protocol itself is a stateless protocol , The client wants to operate the server , It can be done by requesting resources , take " state " To pass .

  • GET Request means to obtain resources .
  • POST The request represents a new resource .
  • PUT Request means to update the resource .
  • DELETE Request means delete resource .

Two 、SpringBoot And Swagger-ui Fast integration

1、 The first way : Using official dependencies

One 、 Import dependence

 <properties>
<swagger.version>2.9.2</swagger.version>
</properties>
<!--swagger2 Officials rely on -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>${swagger.version}</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>${swagger.version}</version>
</dependency>

Two 、 To write Swagger Configuration file for

@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.pathMapping("/")
.select()
// For the current package controller Generate API file
.apis(RequestHandlerSelectors.basePackage("com.hyh.fireworks.web"))
// To have @Api Annotated Controller Generate API file
//.apis(RequestHandlerSelectors.withClassAnnotation(Api.class))
// To have @ApiOperation Annotation method generation API file
//.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("Swagger Interface document ")
.description("Fireworks Bokee.com Interface document ")
.contact(new Contact(" God, jojobasha ", "https://www.hyhwky.com", "1332790762@qq.com"))
.version("1.0")
.build();
}
}

3、 ... and 、 In the entity class model On the application of annotations

@Data
@AllArgsConstructor
@NoArgsConstructor
@ApiModel(value = "User object ", description = " User table ")
public class User implements Serializable {
private static final long serialVersionUID = 1L;
@ApiModelProperty(value = "id")
private Integer id;
@ApiModelProperty(value = " user name ")
private String name;
@ApiModelProperty(value = " Age ")
private Integer age;
}

Four 、 Applying annotations to interfaces

notes : The following comments can be tested successfully without adding any comments , But for the sake of document readability , It is suggested to add method notes .

@Api(tags = "User controller ") // Decorate the whole class , describe Controller The role of
@RestController
@RequestMapping("/users")
public class UserController {
private static final List<User> USERS = new ArrayList<>();
static {
USERS.add(new User(1,"hyh",12));
USERS.add(new User(2,"summer day",18));
USERS.add(new User(3," God, jojobasha ",20));
}
@GetMapping("/{id}")
@ApiOperation(" Get specified user")
public User getUser(@PathVariable @ApiParam(value = "id",required = true,defaultValue = "3") Integer id){
return USERS.get(id - 1);
}
@DeleteMapping("/{id}")
@ApiOperation(" Delete the specified user")
@ApiImplicitParam(name = "id", value = "user id", required = true, dataType = "Integer",paramType = "path")
public String deleteUser(@PathVariable Integer id){
USERS.remove(id - 1);
return "success";
}
@PostMapping()
@ApiOperation(" New users ")
public String postUser(@RequestBody User user){
USERS.add(user);
return "success";
}
@PutMapping("/{id}")
@ApiOperation(" Update user ")
@ApiImplicitParams({
@ApiImplicitParam(name = "id", value = "id", required = true, dataType = "Integer",paramType = "path"),
@ApiImplicitParam(name = "user", value = "user Entity ", required = true, dataType = "User")
})
public String putUser(@PathVariable Integer id , @RequestBody User user){
user.setId(id);
USERS.set(id - 1,user);
return "success";
}
@GetMapping()
@ApiOperation(" User list ")
public List<User> getUsers(){
return USERS;
}
@ApiIgnore // When generating interface documents , Ignore the interface
@GetMapping("/ignore")
public String ignoreTest(){
return "ignore";
}
}

5、 ... and 、 visit http://localhost:8081/swagger-ui.html You can see the effect

2、 The second way : Using third party dependencies

Document and source code address :https://github.com/SpringForAll/spring-boot-starter-swagger, There are detailed documents in it , utilize Spring Boot Automatic configuration features to achieve fast will swagger2 introduce spring boot Apply to generate API file , Simplify native use swagger2 The integration code of .

Interested partners can follow the document demo Test it yourself .

3、 ... and 、swagger-ui The basic notes of

  • @Api: Used to modify Controller class
  • @ApiOperation: Used to modify Controller Class Method
  • @ApiParam: Used to decorate... In an interface Parameters
  • @ApiModelProperty: Used to modify Properties of entity class

Source download

The content of this article is a summary of excellent blogs and official documents , The address of the original text has been marked in the reference section of the text . Last , All the code samples in this article have been uploaded to Gitee:https://gitee.com/tqbx/springboot-samples-learn, There are other SpringBoot The integration of oh .

Reference reading

版权声明
本文为[Tian Qiao Ba Xia]所创,转载请带上原文链接,感谢

  1. 【计算机网络 12(1),尚学堂马士兵Java视频教程
  2. 【程序猿历程,史上最全的Java面试题集锦在这里
  3. 【程序猿历程(1),Javaweb视频教程百度云
  4. Notes on MySQL 45 lectures (1-7)
  5. [computer network 12 (1), Shang Xuetang Ma soldier java video tutorial
  6. The most complete collection of Java interview questions in history is here
  7. [process of program ape (1), JavaWeb video tutorial, baidu cloud
  8. Notes on MySQL 45 lectures (1-7)
  9. 精进 Spring Boot 03:Spring Boot 的配置文件和配置管理,以及用三种方式读取配置文件
  10. Refined spring boot 03: spring boot configuration files and configuration management, and reading configuration files in three ways
  11. 精进 Spring Boot 03:Spring Boot 的配置文件和配置管理,以及用三种方式读取配置文件
  12. Refined spring boot 03: spring boot configuration files and configuration management, and reading configuration files in three ways
  13. 【递归,Java传智播客笔记
  14. [recursion, Java intelligence podcast notes
  15. [adhere to painting for 386 days] the beginning of spring of 24 solar terms
  16. K8S系列第八篇(Service、EndPoints以及高可用kubeadm部署)
  17. K8s Series Part 8 (service, endpoints and high availability kubeadm deployment)
  18. 【重识 HTML (3),350道Java面试真题分享
  19. 【重识 HTML (2),Java并发编程必会的多线程你竟然还不会
  20. 【重识 HTML (1),二本Java小菜鸟4面字节跳动被秒成渣渣
  21. [re recognize HTML (3) and share 350 real Java interview questions
  22. [re recognize HTML (2). Multithreading is a must for Java Concurrent Programming. How dare you not
  23. [re recognize HTML (1), two Java rookies' 4-sided bytes beat and become slag in seconds
  24. 造轮子系列之RPC 1:如何从零开始开发RPC框架
  25. RPC 1: how to develop RPC framework from scratch
  26. 造轮子系列之RPC 1:如何从零开始开发RPC框架
  27. RPC 1: how to develop RPC framework from scratch
  28. 一次性捋清楚吧,对乱糟糟的,Spring事务扩展机制
  29. 一文彻底弄懂如何选择抽象类还是接口,连续四年百度Java岗必问面试题
  30. Redis常用命令
  31. 一双拖鞋引发的血案,狂神说Java系列笔记
  32. 一、mysql基础安装
  33. 一位程序员的独白:尽管我一生坎坷,Java框架面试基础
  34. Clear it all at once. For the messy, spring transaction extension mechanism
  35. A thorough understanding of how to choose abstract classes or interfaces, baidu Java post must ask interview questions for four consecutive years
  36. Redis common commands
  37. A pair of slippers triggered the murder, crazy God said java series notes
  38. 1、 MySQL basic installation
  39. Monologue of a programmer: despite my ups and downs in my life, Java framework is the foundation of interview
  40. 【大厂面试】三面三问Spring循环依赖,请一定要把这篇看完(建议收藏)
  41. 一线互联网企业中,springboot入门项目
  42. 一篇文带你入门SSM框架Spring开发,帮你快速拿Offer
  43. 【面试资料】Java全集、微服务、大数据、数据结构与算法、机器学习知识最全总结,283页pdf
  44. 【leetcode刷题】24.数组中重复的数字——Java版
  45. 【leetcode刷题】23.对称二叉树——Java版
  46. 【leetcode刷题】22.二叉树的中序遍历——Java版
  47. 【leetcode刷题】21.三数之和——Java版
  48. 【leetcode刷题】20.最长回文子串——Java版
  49. 【leetcode刷题】19.回文链表——Java版
  50. 【leetcode刷题】18.反转链表——Java版
  51. 【leetcode刷题】17.相交链表——Java&python版
  52. 【leetcode刷题】16.环形链表——Java版
  53. 【leetcode刷题】15.汉明距离——Java版
  54. 【leetcode刷题】14.找到所有数组中消失的数字——Java版
  55. 【leetcode刷题】13.比特位计数——Java版
  56. oracle控制用户权限命令
  57. 三年Java开发,继阿里,鲁班二期Java架构师
  58. Oracle必须要启动的服务
  59. 万字长文!深入剖析HashMap,Java基础笔试题大全带答案
  60. 一问Kafka就心慌?我却凭着这份,图灵学院vip课程百度云