SuperAPI AI 工具集

litestar-openapi

编程与开发

查看项目

更新于 10-15 16:48

技能介绍

用途:为 Litestar 应用配置 OpenAPI 模式生成与文档界面(UX),让生成的接口文档与运行时行为保持一致。

主要能力:在应用构建时集中设置 OpenAPIConfig,包括标题、版本、文档端点、服务器、标签与渲染插件;在路由级别添加 summary、description、response_description、tags、security、operation_id、raises、include_in_schema 等元数据;在默认模型生成不足时自定义 schema 生成;选择 UI 渲染插件与端点路径;用 openapi_config=None 完全禁用文档。

使用方式:先决定 OpenAPI 是启用、限制还是禁用;在应用构造处设置全局 OpenAPIConfig;仅在需要时添加路由级元数据;需要交互式文档时选用内置渲染插件,而非手写文档页;对内部或运维路由使用 include_in_schema=False 排除在公开文档外。

适用场景:需要对外提供准确 API 文档、按环境选择文档 UI、控制公开与内部路由可见性、让安全与异常文档匹配真实行为的 Litestar 项目。

限制与注意:文档必须真实反映运行时行为,避免记录运行时并不支持的契约;OpenAPI 变更应视为 API 变更并经过评审;不要过度使用路由级覆盖导致 schema 不一致;UI 插件选择涉及端点路径与资源加载,不只是外观问题;自定义 schema 生成前应先理解默认输出。具体配置字段、插件名称与命令资料未提供。