feat: 从 FastAPI 导出 openapi.json 并渲染为 API 文档
通过 vitepress-openapi 插件,在 VitePress 文档中实现基于 openapi.json 的 API 文档。 这样实现的 API 文档可以从最新版本的代码库中提取路由信息,继而实现自动集成。 --- 同时,通过 Kimi 和 Deepseek 实现并审查了一个对 Google 风格 docstring 的解析函数。 该函数可以从 Google 风格的 docstring 中提取参数文档并按 openapi 规范重新整理它们。 --- 增加了 nyahome openapi 命令用来导出 openapi.json。 增加了 task openapi-docs 命令用来准备未来的持续集成。
This commit is contained in:
+4
-2
@@ -1,10 +1,12 @@
|
||||
{
|
||||
"type": "module",
|
||||
"devDependencies": {
|
||||
"mjml": "^5.2.2",
|
||||
"vitepress": "2.0.0-alpha.17"
|
||||
"vitepress": "2.0.0-alpha.17",
|
||||
"vitepress-openapi": "^0.2.0"
|
||||
},
|
||||
"scripts": {
|
||||
"dev": "vitepress dev docs",
|
||||
"dev": "vitepress dev docs --port 6173",
|
||||
"build": "vitepress build docs",
|
||||
"preview": "vitepress preview docs"
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user