Shulou(Shulou.com)06/03 Report--

This article focuses on "how to use Swagger and SpringBoot". Interested friends may wish to have a look at it. The method introduced in this paper is simple, fast and practical. Now let the editor take you to learn how to use Swagger and SpringBoot.

(1) introduction

In my first job, the technical architecture was relatively old, and I wrote an interface document manually when I wrote the Api interface. But once there are more interfaces, these documents are difficult to manage. My current work uses SpringBoot at the application level, and Swagger2 is heavily used in the project. I personally feel that the power of Swagger is that very few configurations and a few comments can generate a complete technical document, which integrates maintenance documentation and code modification, saving a lot of time.

(2) Integration of Swagger and SpringBoot

The use of Swagger is simple, and it is shown here with a simple example.

(2.1) introduce dependency

First, you need to create a Springboot project and introduce Swagger2-related dependencies:

Io.springfox springfox-swagger2 2.9.2 io.springfox springfox-swagger-ui 2.9.2 (2.2) create entity classes

Because the project is relatively simple, the API API for adding, deleting, changing and querying User classes is implemented, so all of them are placed under a folder to create User.java. Here, two annotations of swagger for entity classes @ ApiModel and @ ApiModelProperty are used to indicate the meaning of entity classes and attributes, respectively.

@ Data@ApiModel ("user entity Class") public class User {@ ApiModelProperty ("id") private Long id; @ ApiModelProperty ("name") private String name; @ ApiModelProperty ("age") private Integer age;} (2.3) create a Swagger2 profile

The configuration of swagger mainly contains basic display information and scanning information, in which the @ Configuration annotation causes Spring to start the configuration class, and @ EnableSwagger2 to start Swagger2

@ Configuration@EnableSwagger2public class SwaggerConfig {@ Bean public Docket createRestApi () {return new Docket (DocumentationType.SWAGGER_2) / / create basic api information .apiInfo (apiInfo ()) .select () / RequestHandlerSelectors.basePackage specifies the path of the scanned package / / RequestHandlerSelectors.any (): scan all / / RequestHandlerSelectors.none (): do not scan / / RequestHandlerSelectors.withClassAnnotation (): scan comments on classes / / RequestHandlerSelectors.withMethodAnnotation (): comments on scanning methods. APIs (RequestHandlerSelectors.basePackage ("com.javayz.swaggerdemo.controller")) / / what path to filter. Paths (PathSelectors.any ( ) .build () } private ApiInfo apiInfo () {return new ApiInfoBuilder () .title ("SwaggerAPI document for Java fry") .description ("you will be tired because you are walking uphill") .termsOfServiceUrl ("https://blog.csdn.net/qq_41973594") .contact (" Java fry "," https://blog.csdn.net/qq_41973594", ") "974474148@qq.com") .version ("1.0") .build () }}

The parameters in ApiInfo are as follows:

Create Controller, define API@Api (value= "user Information Management") @ RestController@RequestMapping (value= "/ users") public class UserController {/ / create a thread-safe map static Map users = Collections.synchronizedMap (new HashMap ()) / / get User list @ ApiOperation (value= "get user list", notes= "") @ RequestMapping (value= {"}, method= RequestMethod.GET) public List getUserList () {List r = new ArrayList (users.values ()); return r Delete user @ ApiOperation according to user id (value = "delete user", notes = "delete user based on id") @ ApiImplicitParam (name = "id", value = "input user id", required = true,dataType = "Long") @ RequestMapping (value = "/ {id}", method = RequestMethod.DELETE) public String DeleteList (@ PathVariable Long id) {users.remove (id); return "success" } / / create user @ ApiOperation (value= "create user", notes= "create user based on User object") @ ApiImplicitParam (name = "user", value= "user detail entity user", required = true, dataType = "User") @ RequestMapping (value= ", method=RequestMethod.POST) public String postUser (@ RequestBody User user) {users.put (user.getId (), user); return" success " } / / obtain user information according to user id @ ApiOperation (value= "get user details", notes= "get user details according to url id") @ ApiImplicitParam (name = "id", value= "user ID", required = true, dataType = "Long") @ RequestMapping (value= "/ {id}", method=RequestMethod.GET) public User getUser (@ PathVariable Long id) {return users.get (id) } / / Update object @ ApiOperation according to the specified id (value= "update user details", notes= "specify the update object according to the id of url And update the user details according to the passed user information ") @ ApiImplicitParams ({@ ApiImplicitParam (name =" id ", value=" user ID ", required = true, dataType =" Long "), @ ApiImplicitParam (name =" user ", value=" user detail user ", required = true, dataType =" User ") @ RequestMapping (value=" / {id} ", method=RequestMethod.PUT) public String putUser (@ PathVariable Long id) @ RequestBody User user) {User u = users.get (id) U.setName (user.getName ()); u.setAge (user.getAge ()); users.put (id, u); return "success";}}

At first glance, the above code has a lot of configuration files, but it is actually very easy to use, adding notes to API through @ Api and @ ApiOperation annotations, and parameters through @ ApiImplicitParams and @ ApiImplicitParam annotations. The functions of annotated parameters are as follows:

@ Api: used on the requested class, indicating the description of the class tags= "indicates the function of the class. The note" value= "that can be seen on the UI interface does not make any sense, and it can also be seen on the UI interface, so there is no need to configure" @ ApiOperation: used on the requested method. " Description of the purpose of the method, function of value= "description of the use of the method, notes for the" notes= "method @ ApiImplicitParams: used on the requested method, indicating a set of parameter descriptions @ ApiImplicitParam: used in @ ApiImplicitParams comments Specify all aspects of a request parameter name: parameter name value: the Chinese character description of the parameter, Explain whether the required: parameter must be passed paramType: where to put the parameter header-- > request parameter acquisition: @ RequestHeader query-- > request parameter acquisition: @ RequestParam path (for restful API)-> request parameter acquisition: @ PathVariable body (rarely used) form (rarely used) dataType: parameter type Default String, other values dataType= "Integer" defaultValue: default value @ ApiResponses: used in the request method to represent a set of responses @ ApiResponse: used in @ ApiResponses, it is generally used to express an error response information code: number, such as 400 message: information, such as "request parameters are not filled" response: class @ ApiModel: used on the response class Represents a message that returns response data (this is commonly used when creating a post, using scenarios such as @ RequestBody, where request parameters cannot be described using @ ApiImplicitParam annotations) @ ApiModelProperty: used on properties to describe the properties of the response class (3) run the project

After all the code is completed, start the SpringBoot project and type http://localhost:8080/swagger-ui.html on the browser to see the RESTful API interface.

The interface can be tested directly in this interface, and each code change is synchronized to the interface document. We just need to send this path to the front-end students and we are done.

At this point, I believe you have a deeper understanding of "how to use Swagger and SpringBoot". You might as well do it in practice. Here is the website, more related content can enter the relevant channels to inquire, follow us, continue to learn!

Welcome to subscribe "Shulou Technology Information " to get latest news, interesting things and hot topics in the IT industry, and controls the hottest and latest Internet news, technology news and IT industry trends.