在 Linux 上启动 Swagger 取决于你使用的是哪种 Swagger 相关工具。下面按最常见场景给你说明,基本都能覆盖 90% 的情况。
docker run -p 8080:8080 swaggerapi/swagger-ui
访问:
http://localhost:8080
✅ 适合:查看已有 Swagger / OpenAPI 文档
wget https://github.com/swagger-api/swagger-ui/archive/refs/tags/v5.17.14.zip
unzip v5.17.14.zip
cd swagger-ui-5.17.14/dist
python3 -m http.server 8080
访问:
http://localhost:8080
依赖:
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
<version>2.3.0</version>
</dependency>
启动项目后访问:
http://localhost:8080/swagger-ui.html
或:
http://localhost:8080/swagger-ui/index.html
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>
访问:
http://localhost:8080/swagger-ui/
⚠️ Swagger2 已停止维护
npm install swagger-ui-express swagger-jsdoc
const swaggerJsdoc = require('swagger-jsdoc');
const swaggerUi = require('swagger-ui-express');
const app = require('express')();
const spec = swaggerJsdoc({ definition: { openapi: '3.0.0' }, apis: ['./index.js'] });
app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(spec));
app.listen(3000);
访问:
http://localhost:3000/api-docs
docker run -p 8081:8080 swaggerapi/swagger-editor
访问:
http://localhost:8081
curl http://localhost:8080
检查:
| 场景 | 推荐 |
|---|---|
| 只看接口文档 | Swagger UI |
| Spring Boot | springdoc-openapi |
| 写 OpenAPI | Swagger Editor |
| 前端项目 | swagger-jsdoc |
如果你愿意,可以直接告诉我:
我可以一步一步帮你配 ✅