Spring项目中swagger用法与swagger

Spring项目中swagger用法与swagger

一、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;

@RestConPciJltroller

@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 Arhttp://rayList<>();

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的封装。

xmlns:xsi="http://w3.org/2001/XMLSchema-instance"

xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

4.0.0

com.xbmu

swagger-study

1.0-SNAPSHOT

8

8

org.springframework.boot

spring-boot-dependencies

2.2.5.RELEASE

pom

import

org.springframework.boot

spring-boot-starter-web

io.springfox

springfox-swagger2

2.9.2

io.springfox

springfox-swagger-ui

2.9.2

xmlns:xsi="http://w3.org/2001/XMLSchema-instance"

xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

4.0.0

com.xbmu

swagger-study

1.0-SNAPSHOT

8

8

org.springframework.boot

spring-boot-dependencies

2.2.5.RELEASE

pom

import

org.springframework.boot

spring-boot-starter-web

io.springfox

springfox-swagger2

2.9.2

io.springfox

springfox-swagger-ui

2.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 MyAhttp://pp {

public static void main(String[] args) {

SpringApplication.run(MyApp.class,args);

}

}

1.4、访问swagger-ui

启动项目后在浏览器中输入 http://ip:port/swagger-ui.html 既可以访问到swagger-ui页面，在页面中可以可视化的进行操作项目中所有接口。

二、swagger-ui使用

访问swagger-ui.html后面可以在页面中看到所有需要生成接口文档的额控制器名称。

每个控制器中包含多个所有控制器方法的各种访问方式。如果使用的是@RequestMapping进行映射，将显示下面的所有请求方式。如果使用@PostMapping将只有post方式可以能访问，下面也就只显示post的一个。

点击某个请求方式中 try it out

会出现界面要求输入的值。输入完成后点击Execute按钮

以上就是Spring项目中swagger用法与swagger-ui使用的详细内容，更多关于swagger用法与swagger-ui使用的资料请关注我们其它相关文章！

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。