<dependency>
<groupId>net.ifok.swagger</groupId>
<artifactId>swagger-spring-boot-starter</artifactId>
<version>1.3.0</version>
</dependency>
$title(pom.xml)
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>net.ifok.swagger</groupId>
<artifactId>swagger-spring-boot-starter</artifactId>
<version>1.3.0</version>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
接下来就是配置了,配置我这里建议使用yml格式的,因为yml格式支持UTF8编码,可以更好的使用中文。当然properties 通过编码转换也行。下面就是一个简单的yml格式配置例子其他低版本的spring boot 使用,请参考说明 Swagger Spring Boot Stater
$title(application.yml)
spring:
swagger:
api-title: 某某APP接口文档
api-version: v1.0
contact:
url: https://www.leftso.com
email: example@leftso.com
name: leftso.com
url-pattern: /api/**
更多的配置请参考说明:Swagger Spring Boot Stater
$title(DemoController.java)
package com.example.swagger;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
/**
* @Description: 测试类
* @Author: xq
* @Date: 2021/3/17 8:51
**/
@RestController
@RequestMapping("/api/")
public class DemoController {
@ApiOperation("get获取接口")
@GetMapping("get")
public String getData(String param){
return "Ok";
}
@ApiOperation("post提交接口")
@PostMapping("post")
public Result postData(String name,String age){
return Result.success(name);
}
}
地址:https://www.leftso.com/article/794.html