ubuntu swagger使用教程 - 问答

在Ubuntu上使用Swagger进行API文档生成和测试，通常涉及安装Swagger UI和Swagger Editor，然后配置和使用它们。以下是详细的步骤：

首先，确保你的系统上已经安装了Node.js和npm。你可以通过以下命令来安装：

sudo apt update
sudo apt install nodejs npm

下载Swagger Editor：

访问Swagger Editor的GitHub发布页面，下载最新版本的Swagger Editor。
```
wget https://github.com/swagger-api/swagger-editor/archive/refs/tags/v3.16.1.tar.gz
```

解压并启动Swagger Editor：

tar -xvf v3.16.1.tar.gz
cd swagger-editor-3.16.1
npm install
npm install -g http-server

启动Swagger Editor：
```
http-server -p 8080
```
现在，你可以在浏览器中访问 http://localhost:8080 来使用Swagger Editor。

下载Swagger UI：

访问Swagger UI的GitHub发布页面，下载最新版本的Swagger UI。
```
wget https://github.com/swagger-api/swagger-ui/archive/refs/tags/v3.48.0.tar.gz
```

解压并启动Swagger UI：

tar -xvf v3.48.0.tar.gz
cd swagger-ui-3.48.0
npm install
npm install -g http-server

启动Swagger UI：
```
http-server -p 8081
```
现在，你可以在浏览器中访问 http://localhost:8081 来使用Swagger UI。

Swagger Editor：默认情况下，Swagger Editor会加载 https://petstore.swagger.io/v2/swagger.json。你可以通过编辑 index.html 文件来更改默认的Swagger规范文件路径。
Swagger UI：在Swagger UI中，你可以通过输入框来输入你的Swagger规范文件（通常是 swagger.yaml 或 swagger.json）的URL，然后点击“Explore”按钮来加载和测试你的API接口。

安装Docker：

sudo apt update
sudo apt install docker.io

拉取并运行Swagger UI Docker镜像：

docker pull swaggerapi/swagger-ui-express
docker run -p 8080:8080 swaggerapi/swagger-ui-express

使用Swagger Editor生成API文档：
- 打开Swagger Editor后，点击“File” - “Import” - “Open File”，然后选择你的 swagger.yaml 或 swagger.json 文件。
- 编辑和查看文档。
使用编程方式生成Swagger文档：
- 添加Swagger依赖。
- 编写API注解。
- 配置Swagger生成器。
- 运行项目，Swagger会自动生成API文档。
访问Swagger UI查看生成的文档：

项目启动后，访问Swagger UI的端点（通常是 http://localhost:8080/swagger-ui.html），你应该能看到生成的API文档。

以上步骤应该可以帮助你在Ubuntu上成功安装和配置Swagger，并进行API文档的查看和测试。如果在安装过程中遇到问题，可以参考相关的官方文档或社区论坛寻求帮助。

0 赞

0 踩