用注解的方式写restful风格的Api文档
依赖配置
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.6.1</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.6.1</version>
</dependency>
配置类
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.demo.controller")) //必须存在
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("Spring 中使用Swagger2构建RESTful APIs") //标题
.description("swagger2") 描述
.contact(new Contact("姓名", "网址", "邮箱"))
.version("1.1") //版本
.build();
}
}
使用
@Api(value = "/test", description="用户相关操作")
@RestController
@RequestMapping("/test")
public class TestController {
private static final Logger log = LoggerFactory.getLogger(TestController.class);
@Autowired
private UserDao userDao;
@RequestMapping(value = "/getUserAll", method = RequestMethod.GET)
@ApiOperation(value = "用户查询服务", notes = "查询所有用户")
public List<User> getUserAll(){
return userDao.getAllUser();
}
@RequestMapping(value = "/getUserByUsername", method = RequestMethod.GET)
@ApiOperation(value = "用户查询服务", notes = "查询所有用户")
public User getUserByUsername(@RequestParam @ApiParam(name="username",value="用户名",required=true)String username){
return userDao.getUserByUsername(username);
}
@RequestMapping(value = "/showHello" )
@ApiIgnore
public ModelAndView showHello() {
User user = userDao.getUserByUsername("test");
return new ModelAndView("hello");
}
}
@ApiIgnore()用于类,方法,方法参数 ,表示这个方法或者类被忽略
@ApiIgnore
@Api:用在请求的类上,说明该类的作用
@Api(value = "/test", description="用户相关操作")
@ApiOperation:用在请求的方法上,说明方法的作用
@ApiOperation(value = "用户查询服务", notes = "查询所有用户")
@ApiImplicitParams:用在请求的方法上,包含一组参数说明
@ApiParam(name="username",value="用户名",required=true)
@ApiImplicitParams:用在请求的方法上,包含一组参数说明
@ApiImplicitParam:用在 @ApiImplicitParams 注解中,指定一个请求参数的配置信息
name:参数名
value:参数的汉字说明、解释
required:参数是否必须传
paramType:参数放在哪个地方
· header --> 请求参数的获取:@RequestHeader
· query --> 请求参数的获取:@RequestParam
· path(用于restful接口)--> 请求参数的获取:@PathVariable
· body(不常用)
· form(不常用)
dataType:参数类型,默认String,其它值dataType="Integer"
defaultValue:参数的默认值
@ApiResponses:用于请求的方法上,表示一组响应
@ApiResponses:用于请求的方法上,表示一组响应
@ApiResponse:用在@ApiResponses中,一般用于表达一个错误的响应信息
code:数字,例如400
message:信息,例如"请求参数没填好"
response:抛出异常的类
@ApiModel:用于响应类上,表示一个返回响应数据的信息
@ApiModel:用于响应类上,表示一个返回响应数据的信息
(用在post数据时,使用@RequestBody接收参数,请求参数无法使用@ApiImplicitParam注解进行描述)
@ApiModelProperty:用在属性上,描述响应类的属性