centos

centos swagger注解使用指南

小樊
34
2025-08-10 18:22:35
栏目: 智能运维

以下是在CentOS上使用Swagger注解的指南:

环境准备

安装Java环境,使用命令sudo yum install -y java-1.8.0-openjdk-devel。安装Maven,命令为sudo yum install -y maven

添加依赖

如果是Maven项目,在pom.xml中添加Swagger依赖,如springfox-swagger2springfox-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文档。

0
看了该问题的人还看了