Expand description
§SZ-ORM Swagger — OpenAPI/Swagger 规范生成
提供 OpenAPI 3.0 规范的构建与序列化，支持路径、方法、参数、响应、 Schema 定义、SecurityScheme、Tags、Servers 与示例生成，输出可被 Swagger UI 等工具直接消费。
§主要类型
OpenAPISpec— 规范根对象PathInfo— 单个 (path, method) 操作描述Schema/ [SchemaRef] /ObjectType/ArrayType— Schema 定义SecurityScheme— 认证方案（Basic/Bearer/ApiKey/OAuth2）Tag— 接口分组标签Server— 环境服务器配置ExampleBuilder— 基于 Schema 生成示例
Structs§
- Array
Type - 数组类型 Schema
- Authorization
Code Flow - Authorization Code 流程
- Client
Credentials Flow - Client Credentials 流程
- Components
- 组件表，存放可复用的 Schema 与 SecurityScheme
- Example
- 示例（OpenAPI 3.0 example 对象）
- Example
Builder - 基于 Schema 生成示例值的生成器
- External
Docs - 外部文档链接
- Implicit
Flow - Implicit 流程
- Media
Type - 媒体类型（包含 Schema 与示例）
- OAuth2
Flows - OAuth2 流程集合
- Object
Type - 对象类型 Schema
- OpenAPI
Generator - OpenAPI
Spec - OpenAPI 3.0 规范根对象
- Password
Flow - Password 流程
- Path
Info - Describes a single (path, method) operation in an OpenAPI spec.
- Primitive
Schema - 基本类型 Schema（string/integer/number/boolean）
- Request
Body - 请求体定义
- Security
Requirement - 安全要求：所需认证方案的键值对映射
- Server
- 环境服务器配置
- Server
Variable - 服务器变量（用于 URL 模板替换）
- Swagger
Ui - Tag
- 接口分组标签
Enums§
- ApiKey
Location - API Key 位置
- Schema
- Schema 定义，支持引用、对象、数组、基本类型
- Security
Scheme - 认证方案，支持 HTTP（Basic/Bearer）、ApiKey、OAuth2
Functions§
- model_
to_ openapi_ schema - 将 sz-orm
Model定义转换为 OpenAPI 3.0 对象 Schema。