温馨提示×

centos swagger文档在哪里查看

小樊
50
2025-11-01 19:01:39
栏目: 智能运维

CentOS系统查看Swagger文档的位置及步骤

1. 前提:通过代码生成Swagger文档

Swagger文档(OpenAPI规范)通常需要通过代码中的注解生成(如Spring Boot项目),而非直接“查看”某个固定路径的文件。需先完成以下步骤:

  • 安装依赖:若使用Spring Boot,需添加Swagger相关依赖(如springfox-swagger2springfox-swagger-ui);
  • 配置类:创建Swagger配置类(如SwaggerConfig),指定扫描的包路径和文档基本信息;
  • 代码注解:在Controller、接口方法上添加@Api@ApiOperation等注解,描述API细节;
  • 生成文档:启动项目后,Swagger会自动生成JSON格式的文档(默认路径为/v2/api-docs)。

2. 查看Swagger UI的常用方式

Swagger UI是可视化工具,用于交互式查看和测试API文档。在CentOS上,可通过以下两种方式访问:

方式一:本地启动Swagger UI服务
  • 下载并解压Swagger UI
    mkdir -p /opt/swagger
    cd /opt/swagger
    wget https://github.com/swagger-api/swagger-ui/archive/v3.34.0.tar.gz
    tar -xf v3.34.0.tar.gz
    cd swagger-ui-3.34.0
    
  • 配置静态资源
    将解压后的dist目录内容复制到Web服务器目录(如Apache的/var/www/html/swagger-ui或Nginx的/usr/share/nginx/html/swagger-ui);
  • 修改配置文件
    编辑index.html,将默认的Swagger JSON URL(如https://petstore.swagger.io/v2/swagger.json)替换为你的项目文档路径(如/v2/api-docs);
  • 启动Web服务器
    若使用Apache,启动服务并设置开机自启:
    sudo systemctl start httpd
    sudo systemctl enable httpd
    
  • 访问文档
    在浏览器中输入服务器IP或域名,加上Swagger UI路径(如http://your-server-ip/swagger-ui/index.html)。
方式二:集成到现有应用(推荐)

若项目是基于Spring Boot开发的,可直接通过项目内置的Swagger UI访问:

  • 配置后端:确保SwaggerConfig类中启用了Swagger UI(如@EnableSwagger2);
  • 访问路径:启动项目后,在浏览器中输入http://localhost:8080/swagger-ui.html(若项目部署在CentOS服务器上,需将localhost替换为服务器IP)。

注意事项

  • 防火墙设置:确保CentOS防火墙开放了相关端口(如80、443或项目端口),允许外部访问;
  • 路径调整:若项目部署在非根路径(如/api),需修改Swagger UI配置中的basePath,确保文档路径正确;
  • 生产环境安全:建议启用HTTPS,并配置认证机制(如API Key、OAuth2),避免未授权访问。

通过以上步骤,你可以在CentOS系统上成功查看和交互式测试Swagger文档。

0