Spring Interface Documentation Note: @ApiOperation

Source: Internet
Author: User

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)

Contact Us

The content source of this page is from Internet, which doesn't represent Alibaba Cloud's opinion; products and services mentioned on that page don't have any relationship with Alibaba Cloud. If the content of the page makes you feel confusing, please write us an email, we will handle the problem within 5 days after receiving your email.

If you find any instances of plagiarism from the community, please send an email to: info-contact@alibabacloud.com and provide relevant evidence. A staff member will contact you within 5 working days.

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.