springboot06-swagger2 自动化api文档

1.springboot 项目中添加swagger2依赖:

        <dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency> <dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.2.2</version>
</dependency>

2.启动类中添加swagger注解支持:

@SpringBootApplication
@EnableSwagger2 //启动swagger注解 启动服务,浏览器输入"http://服务名:8080/swagger-ui.html"
@ComponentScan(basePackages = {"com.mlxs.springboot06.swagger"})
public class MainApp {
public static void main(String[] args) {
SpringApplication.run(MainApp.class, args);
}
}

3.自定义接口中填写api文档信息:

package com.mlxs.springboot06.swagger;

import com.mlxs.springboot06.swagger.bean.User;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController; import java.util.ArrayList;
import java.util.List; /**
* UserResource类描述:
*
* swagger2使用说明:
@Api:用在类上,说明该类的作用
@ApiOperation:用在方法上,说明方法的作用
@ApiImplicitParams:用在方法上包含一组参数说明
@ApiImplicitParam:用在@ApiImplicitParams注解中,指定一个请求参数的各个方面
paramType:参数放在哪个地方
header-->请求参数的获取:@RequestHeader
query-->请求参数的获取:@RequestParam
path(用于restful接口)-->请求参数的获取:@PathVariable
body(不常用)
form(不常用)
name:参数名
dataType:参数类型
required:参数是否必须传
value:参数的意思
defaultValue:参数的默认值
@ApiResponses:用于表示一组响应
@ApiResponse:用在@ApiResponses中,一般用于表达一个错误的响应信息
code:数字,例如400
message:信息,例如"请求参数没填好"
response:抛出异常的类
@ApiModel:描述一个Model的信息(这种一般用在post创建的时候,使用@RequestBody这样的场景,请求参数无法使用@ApiImplicitParam注解进行描述的时候)
@ApiModelProperty:描述一个model的属性
*
* @author yangzhenlong
* @since 2017/2/20
*/
@RestController
@RequestMapping("/user")
public class UserResource { @ApiOperation(value = "用户列表", httpMethod = "GET")
@RequestMapping(value = "/list", method = {RequestMethod.GET})
public List<User> userList(){
List<User> userList = new ArrayList<>();
for (int i=1; i<= 5; i++){
User user = new User(i, "用户" + i);
userList.add(user);
}
return userList;
} @ApiOperation(value = "根据Id获取用户信息", httpMethod = "GET")
@ApiImplicitParam(paramType = "query", name = "id", required = true, value = "用户id", defaultValue = "1")
@RequestMapping(value = "/get", method = {RequestMethod.GET})
public User userList(Integer id){
List<User> userList = new ArrayList<>();
for (int i=1; i<= 5; i++){
User user = new User(i, "用户" + i);
userList.add(user);
}
return userList.get(id -1);
}
}

4.启动MainApp类,浏览器访问http://localhost:8080/swagger-ui.html 查看效果:

springboot06-swagger2 自动化api文档

springboot06-swagger2 自动化api文档

springboot06-swagger2 自动化api文档

上一篇:maven如何修改本地仓库与*仓库


下一篇:爱你不容易 —— Stream详解