本页长期有效 · 建议 Ctrl+D 收藏全部工具

接口文档工具

Swagger UI / Redoc / Apifox 替代

适用环境：自动生成 · 在线调试 · 开箱即用

一键安装命令

Windows 10/11 自带 winget。按 Win + X 打开「终端(管理员)」，逐条粘贴执行。

# 多数框架自带，见资源页说明

Swagger UI

OpenAPI 规范的标准渲染，能直接调接口官方页 →

Redoc

文档排版更漂亮，适合对外发布官方页 →

OpenAPI Generator

按规范生成各语言客户端代码官方页 →

1FastAPI 自动文档

FastAPI 默认就带 /docs（Swagger）和 /redoc（Redoc），不用额外配置。

2手写 openapi.yaml

openapi: 3.0.0 info: title: 我的 API version: 1.0.0 paths: /users: get: summary: 用户列表 responses: '200': description: OK

3本地预览

npx @redocly/cli preview-docs openapi.yaml 或者用 Swagger Editor 在线版粘贴。

4生成客户端

openapi-generator-cli generate -i openapi.yaml -g typescript-axios -o ./client

Q：文档和代码不一致

A：最好从代码注解生成规范（FastAPI 自动做），不要手写维护。

Q：中文文档乱码

A：yaml 文件存为 UTF-8，Swagger UI 要设 charset=utf-8。