Spring项目中swagger用法与swagger-ui使用

这篇文章主要介绍了Spring项目中swagger用法与swagger-ui使用,通过图文并茂的形式给大家介绍了编写springboot项目的方法及导入spring-fox依赖的代码详解，需要的朋友可以参考下

一、swagger用法

1.1、编写springboot项目

在这里插入图片描述

 package com.xbmu.controller; import com.xbmu.bean.Person; import org.springframework.web.bind.annotation.*; import java.util.ArrayList; import java.util.List; @RestController @RequestMapping(value = "/person") public class PersonController { @PostMapping("/postReq") public String postReq() { return "postReq"; } @GetMapping("/getReq") public String getReq(String param1,String param2) { return "getReq"; } @RequestMapping("/req") public String req(String param1) { return "req"; } @RequestMapping(value = "/getPersonSingle",method = RequestMethod.GET) private Person getPersonSingle(Integer id){ Person person; List personList = new ArrayList<>(); for (int i = 0; i <10; i++) { person = new Person(); person.setId(i+1); person.setName("zhangsan"+(i+1)); person.setGender("男"+i); person.setAge(18+1); person.setAddress("shanxi xian"); personList.add(person); } person = personList.get(id); return person; } }

1.2、导入spring-fox依赖

在项目pom.xml中导入spring-fox依赖，该项目选择版本为2.9.2。其中springfox-swagger2是核心内容的封装。springfox-swagger-ui是对swagger-ui的封装。

   4.0.0com.xbmuswagger-study1.0-SNAPSHOT 88   org.springframework.bootspring-boot-dependencies2.2.5.RELEASEpomimport  org.springframework.bootspring-boot-starter-web io.springfoxspringfox-swagger22.9.2 io.springfoxspringfox-swagger-ui2.9.2

1.3、添加注解

在springboot的启动类中添加 @EnableSwagger2 注解。
添加此注解后表示对当前项目中全部控制器进行扫描。应用swagger2。

 package com.xbmu; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import springfox.documentation.swagger2.annotations.EnableSwagger2; /** * EnableSwagger2 是springfox提供的一个注解，代表swagger2相关技术开启。 * 会扫描当前类所在包，及子包中所有的类型中的注解。 */ @SpringBootApplication @EnableSwagger2 public class MyApp { public static void main(String[] args) { SpringApplication.run(MyApp.class,args); } }