spring boot series

1. Spring boot series of tutorials

http://blog.csdn.net/lxhjh/article/category/6277040  (spring boot series of tutorials)

http://www.cnblogs.com/larryzeal/p/5765945.html  (Spring Boot learning)

http://www.cnblogs.com/larryzeal/p/5799195.html  (Spring Boot Official Document Learning (1) Getting Started and Using)

http://www.cnblogs.com/larryzeal/p/5799633.html  (Spring Boot Official Document Learning (2) Features)

 

http://blog.csdn.net/forezp/article/category/6830966  (Integrated application in spring boot)

 

http://412887952-qq-com.iteye.com/category/356333?page=4  (Learn Spring Boot from scratch)

 

https://github.com/dyc87112/SpringBoot-Learning ( Zhai Yongchao  updated by SpringBoot tutorial  , PDF document, author of physical book  )

 

 2, rest api document class integration

https://www.jianshu.com/p/af7a6f29bf4f  (SpringBoot project generates RESTfull API documentation -- asciidoctor)

http://blog.csdn.net/forezp/article/details/71023510  (create API documentation with spring Restdocs --asciidoctor)

http://houqp.github.io/wbwa/wbwa.html (asciidoctor--Chinese grammar)

http://blog.didispace.com/springbootswagger2/  (Online documentation for building RESTful APIs using Swagger2 in Spring Boot)

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

 

Common annotations:

@ApiOperation: used on the method to explain the function of the method

1.     value: indicates the interface name
2.     notes: Indicates the detailed description of the interface 

@ApiImplicitParams: used on a method to contain a set of parameter descriptions

@ApiImplicitParam: used in the @ApiImplicitParams annotation to specify various aspects of a request parameter

1. paramType: parameter position

• header corresponding annotation: @RequestHeader
• query corresponding annotation: @RequestParam
• Annotation corresponding to path: @PathVariable
• body corresponds to the annotation: @RequestBody

1. name: parameter name
2. dataType: parameter type
3. required: whether the parameter must be passed
4. value: description of the parameter
5. defaultValue: the default value of the parameter

@ApiResponses: used to represent a set of responses

@ApiResponse: used in @ApiResponses, generally used to express a wrong response information

1. code: status code
2. message: return custom information
3. response: the class that throws the exception

@ApiIgnore: Indicates that the interface function is not open to swagger2 for display

 

 Note: The paramType attribute under the @ApiImplicitParam annotation will affect the test of the interface. If the set attribute does not correspond to the spring annotation, the parameter will not be obtained, for example: paramType=path, but the @RequestParam annotation is used in the function, so, You may not be able to get the parameters passed in, you need to correspond according to the above, and change the @RequestParam annotation to @PathVariable to get the corresponding parameters...