以下是在CentOS上使用Swagger注解的指南:
安装Java环境,使用命令sudo yum install -y java-1.8.0-openjdk-devel
。安装Maven,命令为sudo yum install -y maven
。
如果是Maven项目,在pom.xml
中添加Swagger依赖,如springfox-swagger2
和springfox-swagger-ui
,版本可根据需要选择,如<version>3.0.0</version>
。
创建Swagger配置类,使用@Configuration
和@EnableSwagger2
(或@EnableSwagger2WebMvc
)注解,配置Docket
Bean来指定扫描的包路径等。
在Controller类和方法上使用Swagger注解,如@Api
标注Controller类,@ApiOperation
描述操作,@ApiModel
和@ApiModelProperty
描述模型及属性,@PathVariable
、@RequestParam
、@RequestBody
描述参数,@ApiResponse
描述响应等。
启动应用后,通过http://localhost:8080/swagger-ui/index.html
访问Swagger UI,查看和测试API文档。