centos

centos swagger案例分享

小樊
40
2025-08-08 17:32:19
栏目: 智能运维

以下是一些CentOS上使用Swagger的案例分享:

搭建Swagger UI展示API文档

  1. 安装Node.js和npm:通过命令安装,如curl -sL https://rpm.nodesource.com/setup_14.x | sudo -E bash -,再sudo yum install -y nodejs
  2. 安装Swagger UI:从GitHub克隆项目,如git clone https://github.com/swagger-api/swagger-ui.git,然后cd到项目目录安装依赖npm install
  3. 配置并启动:创建index.js文件配置Swagger UI,如指定静态文件目录等,然后node index.js启动,通过浏览器访问http://localhost:3000查看。
  4. 添加API文档:可手动创建或用Swagger Editor生成符合OpenAPI Specification的JSON或YAML文件,将其放到指定目录并通过修改相关配置文件来显示在Swagger UI中。

结合Spring Boot生成API文档

  1. 安装Java和Maven:使用sudo yum install -y java-1.8.0-openjdk-develsudo yum install -y maven安装。
  2. 添加Swagger依赖:在Spring Boot项目的pom.xml中添加springfox-swagger2springfox-swagger-ui依赖。
  3. 配置Swagger:在主类中添加Swagger配置类,使用@EnableSwagger2注解等配置相关信息。
  4. 编写API注释:在代码的路由或控制器文件中添加Swagger注释来描述API。
  5. 查看文档:启动应用后,通过http://localhost:8080/swagger-ui.html访问Swagger UI查看和测试API文档。

0
看了该问题的人还看了