Documenting Rest api using Swagger

Rest apis documentation has great significance when it comes to publishing and testing them. Swagger is a specification for documenting the Rest APIs. It comes with UI that can be used as a GUI to view and test the api.

Annotations provided :

 @Api
@ApiClass
@ApiError
@ApiErrors
@ApiOperation
@ApiParam
@ApiParamImplicit
@ApiParamsImplicit
@ApiProperty
@ApiResponse
@ApiResponses
@ApiModel

/api/api-docs. It is used by Swagger UI which itself is embedded into finalJAR archive and served by Jetty as static web resource.

sample demo :http://petstore.swagger.io/