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:
2026-05-25 14:56:36 +08:00
parent 3117af670b
commit e29f27e2eb
12 changed files with 755 additions and 19 deletions
+29
View File
@@ -0,0 +1,29 @@
---
aside: false
outline: false
title: NyaHome API Docs
---
<script setup lang="ts">
import { useTheme, locals } from 'vitepress-openapi/client'
import { useRoute } from 'vitepress'
const route = useRoute()
useTheme({
i18n: {
locale: 'zh',
},
})
const operationId = route.data.params.operationId
</script>
<OAOperation :operationId="operationId">
<template #branding>
<div class="vitepress-openapi">
<p>API 文档是基于最新代码自动生成的</p>
<p>由 VitePress OpenAPI 提供文档支持</p>
</div>
</template>
</OAOperation>