配置pom
springboot默认导入包
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-devtools</artifactId>
<scope>runtime</scope>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
<exclusions>
<exclusion>
<groupId>org.junit.vintage</groupId>
<artifactId>junit-vintage-engine</artifactId>
</exclusion>
</exclusions>
</dependency>
添加swagger导入jar包
<!--swagger 文档注释-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.7.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.7.0</version>
</dependency>
<!--swagger-->
swagger启动类
类创建在application启动类包下的位置
package com.example.demo2.swagger;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.bind.annotation.RestController;
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;
import java.util.ArrayList;
import java.util.List;
@Configuration
@EnableSwagger2
public class Swagger2Config {
@Bean
public Docket createRestApi() {
List<Parameter> pars = new ArrayList<Parameter>();
return new Docket(DocumentationType.SWAGGER_2)
// .apiInfo(apiInfo())
.select()
//.apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
// .paths(PathSelectors.any())
.build();
//.globalOperationParameters(pars)
// .apiInfo(apiInfo());
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("tang若那天,把该说的话好好说")
//.description("该体谅的不执着,如果那天我")
// .termsOfServiceUrl("https://www.cnblogs.com/xiebq/")
// .version("1.0")
.build();
}
配置接口
@PostMapping("/wlove")post方法
@GetMapping("/getLinkAB")get方法
@RequestMapping("/aa") 任意方法
@RestController 类上必须加RestController注解,才能被识别
package com.example.demo2;
import io.swagger.annotations.Api;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.*;
import java.lang.annotation.Target;
@RestController
public class test {
@GetMapping("/getLinkAB")
public String a(String name,String age){
System.out.println("huanying来到"+name+"age:"+age);
return "你好:"+name;
}
@PostMapping("/wlove")
public String b(String name){
System.out.println("welcome,yuan来是你,"+name);
return "welcome";
}
}
完成,启动springboot,访问swagger
网址为:http://ip:端口号/swagger-ui.html,如
http://localhost:8080/swagger-ui.html