okapi

开源

为 Rust 项目生成 OpenAPI (也称为 Swagger) 文档

738 stars0 点赞0 次浏览

工具介绍

为 Rust 项目生成 OpenAPI (也称为 Swagger) 文档

Okapi: Rocket-Okapi: 为 Rust/Rocket 项目生成自动化 OpenAPI (AKA Swagger) 文档。永远不要再出现过时的文档。 Okapi 会在设置服务器时为您生成文档。它使用 Rust 文档注释和编程逻辑来记录您的 API。生成的 [OpenAPI][OpenAPI_3.0.0] 文件可供各种程序用于可视化文档。 Rocket-okapi 目前包含 [RapiDoc][RapiDoc] 和 [Swagger UI][Swagger_UI]，但也可以使用其他工具。

使用 Okapi 生成的文档示例: - DF Storyteller: RapiDoc, ...[^1]

示例

Json web API: 一个简单示例，展示了 Okapi 的基本知识。
UUID: 一个简单示例，展示了基本知识，但使用 UUID 而不是普通的 u32/u64 ID。
自定义模式: 展示如何在 OpenAPI 文件中添加更多/自定义信息，并将多个模块合并到一个 OpenAPI 文件中。
安全请求保护: 展示如何将身份验证方法实现到 OpenAPI 文件中。它展示了：无身份验证、API 密钥、HTTP 身份验证、OAuth2、OpenID 和 Cookie。