spring boot 系列

1、spring boot 系列教程

http://blog.csdn.net/lxhjh/article/category/6277040 （spring boot系列教程）

http://www.cnblogs.com/larryzeal/p/5765945.html （Spring Boot学习）

http://www.cnblogs.com/larryzeal/p/5799195.html （Spring Boot 官方文档学习（一）入门及使用）

http://www.cnblogs.com/larryzeal/p/5799633.html （Spring Boot 官方文档学习（二）特点）

 

http://blog.csdn.net/forezp/article/category/6830966 （spring boot 中集成应用）

 

http://412887952-qq-com.iteye.com/category/356333?page=4 （从零开始学Spring Boot）

https://github.com/dyc87112/SpringBoot-Learning （SpringBoot 教程 更新的 翟永超，PDF文档，实体书作者 ）

扫描二维码关注公众号，回复： 309436 查看本文章

 2、rest api文档类集成

https://www.jianshu.com/p/af7a6f29bf4f （SpringBoot项目生成RESTfull API的文档--asciidoctor）

http://blog.csdn.net/forezp/article/details/71023510 （用spring Restdocs创建API文档--asciidoctor）

http://houqp.github.io/wbwa/wbwa.html (asciidoctor--中文语法)

http://blog.didispace.com/springbootswagger2/ （Spring Boot中使用Swagger2构建RESTful API在线文档）

https://docs.spring.io/spring-restdocs/docs/current/reference/html5/ （Spring REST Docs） 

常用注解说明：

@ApiOperation：用在方法上，说明方法的作用

1.     value: 表示接口名称
2.     notes: 表示接口详细描述 

@ApiImplicitParams：用在方法上包含一组参数说明

@ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面

1. paramType：参数位置

• header 对应注解：@RequestHeader
• query 对应注解：@RequestParam
• path  对应注解: @PathVariable
• body 对应注解: @RequestBody

1. name：参数名
2. dataType：参数类型
3. required：参数是否必须传
4. value：参数的描述
5. defaultValue：参数的默认值

@ApiResponses：用于表示一组响应

@ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息

1. code：状态码
2. message：返回自定义信息
3. response：抛出异常的类

@ApiIgnore: 表示该接口函数不对swagger2开放展示

 

 注意：@ApiImplicitParam注解下的paramType属性,会影响接口的测试,如果设置的属性跟spring的注解对应不上,会获取不到参数,例如:paramType=path,函数内却使用@RequestParam注解,这样,可能会获取不到传递进来的参数,需要按照上面进行对应,将@RequestParam注解改为@PathVariable才能获取到对应的参数...