117笔记问答Swagger是一种API文档生成工具，它可以通过扫描API代码或手动编写描述文件来生成API文档。Swagger UI是Swagger的一个交互式用户界面，它可以让开发者在浏览器中浏览和测试API。在CentOS系统上安装和配置Swagger，可以使得API文档的生成和展示更加方便和高效。以下是详细介绍：
在CentOS上安装Swagger的步骤
- 安装Node.js和npm：
yum install gcc-c make -y curl -sL https://rpm.nodesource.com/setup_12.x | bash - yum install nodejs -y
- 安装Swagger Editor和Swagger UI：
mkdir /opt/swagger cd /opt/swagger wget https://github.com/swagger-api/swagger-editor/archive/v3.14.0.tar.gz tar -xzf v3.14.0.tar.gz cd swagger-editor-3.14.0 npm install -g http-server http-server -p 8080
- 安装Swagger UI：
cd /opt/swagger wget https://github.com/swagger-api/swagger-ui/archive/v3.34.0.tar.gz tar -xzf v3.34.0.tar.gz cd swagger-ui-3.34.0 npm install express --save mkdir public cp -r ../swagger-ui/dist/* public/
- 启动Swagger UI：
cd /opt/swagger node index.js
访问http://127.0.0.1:8000/static/index.html，即可看到Swagger UI的界面。
使用Swagger UI生成和展示API文档
- 在Swagger Editor中编写API文档：
- 克隆Swagger Editor代码库：
git clone https://github.com/swagger-api/swagger-editor.git
- 启动Swagger Editor：
cd swagger-editor npm install -g http-server http-server -p 8000
- 在Swagger Editor中编写API文档，并保存为JSON格式文件。
- 将API文档部署到Swagger UI：
-
将生成的JSON文件放置在Swagger UI的
public目录下。 -
修改
public/index.html文件中的URL，指向自己的API文档文件。 -
重启Swagger UI服务，即可在浏览器中查看和测试API文档。
通过以上步骤，可以在CentOS系统上成功安装和配置Swagger，从而生成和展示API文档，提高API的可用性和易用性。