Spring Interface Documentation Note: @ApiOperation
@ApiOperation It's not spring's own note, it's in swagger.
Com.wordnik.swagger.annotations.ApiOperation;
@ApiOperation and @apiparam for added API-related annotations, the parameters are described as follows:
@ApiOperation (value = "Interface description", HttpMethod = "Interface Request Mode", Response = "interface return parameter type", notes = "interface Release notes"; Other parameters can refer to source code;
@ApiParam (required = "parameter Required", name = "parameter name", value = "Parameter specific description"
In real-world projects, it is very important to write documents to improve the interface efficiency of Java server and Web front end and mobile.
Swagger is an open source project that is currently best used for RESTful API documentation, through the Swagger-spring project
Enables seamless integration with the SPINGMVC framework, facilitating the creation of Spring RESTful interface documentation,
The Swagger-ui can also test the spring RESTful interface functionality.
Spring Interface Documentation Note: @ApiOperation (RPM)