Struct OpenApiDoc 

pub struct OpenApiDoc { /* private fields */ }

OpenAPI文档构建器

提供便捷的方法来构建和管理OpenAPI文档。

Implementations

impl OpenApiDoc

pub fn new(title: &str, version: &str) -> Self

创建一个新的OpenAPI文档

参数

• title: API标题
• version: API版本

示例

use silent_openapi::OpenApiDoc;

let doc = OpenApiDoc::new("用户API", "1.0.0");

pub fn from_openapi(openapi: OpenApi) -> Self

由现有的 OpenApi 对象创建文档包装

pub fn description<S: Into<String>>(self, description: S) -> Self

设置API描述

pub fn add_server(self, url: &str, description: Option<&str>) -> Self

添加服务器信息

参数

• url: 服务器URL
• description: 服务器描述

pub fn add_path(self, path: &str, path_item: PathItem) -> Self

添加路径项

参数

• path: API路径
• path_item: 路径项定义

pub fn add_paths(self, paths: Vec<(String, PathItem)>) -> Self

批量添加路径

参数

• paths: 路径映射表

pub fn add_placeholder_schemas(self, type_names: &[&str]) -> Self

为给定类型名追加占位 schema（占位 Object，用于引用解析）

pub fn apply_registered_schemas(self) -> Self

应用由 endpoint 宏注册的 ToSchema 完整 schema

pub fn add_bearer_auth( self, scheme_name: &str, description: Option<&str>, ) -> Self

添加 Bearer/JWT 安全定义

pub fn set_global_security(self, scheme_name: &str, scopes: &[&str]) -> Self

设置全局 security 要求

pub fn openapi(&self) -> &OpenApi

获取内部的OpenAPI对象

pub fn into_openapi(self) -> OpenApi

转换为OpenAPI对象

pub fn to_json(&self) -> Result<String>

序列化为JSON字符串

pub fn to_pretty_json(&self) -> Result<String>

序列化为格式化的JSON字符串

pub fn to_json_value(&self) -> Result<Value>

序列化为JSON Value

Trait Implementations

impl Clone for OpenApiDoc

fn clone(&self) -> OpenApiDoc

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.