学习 Linux 下的 Swagger(更准确地说,是在 Linux 环境中使用 Swagger/OpenAPI 进行 API 设计、生成和测试),可以按照下面循序渐进的路线来。
Swagger ≠ 某一个工具
Linux 只是运行环境
你需要会:
cd / ls / mkdir / vim / curl / wget
以及:
示例(Ubuntu):
sudo apt update
sudo apt install nodejs npm
docker run -p 8080:8080 swaggerapi/swagger-ui
浏览器访问:
http://localhost:8080
npm install -g swagger-ui-express
swagger.yamlopenapi: 3.0.0
info:
title: User API
version: 1.0.0
paths:
/users:
get:
summary: 获取用户列表
responses:
'200':
description: 成功
npm install @openapitools/openapi-generator-cli -g
openapi-generator-cli generate \
-i swagger.yaml \
-g spring \
-o ./generated
支持语言:
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
</dependency>
访问:
http://localhost:8080/swagger-ui.html
from fastapi import FastAPI
app = FastAPI()
@app.get("/items")
def read_items():
return [{"name": "item"}]
自带 Swagger:
http://localhost:8000/docs
✅ 第 1 周
✅ 第 2 周
✅ 第 3 周
✅ 第 4 周
如果你愿意,可以告诉我:
我可以给你更具体的 Linux 实战教程。