Struct OpenApiBuilder 

pub struct OpenApiBuilder { /* private fields */ }

OpenAPI 文档构建器

提供流畅的 API 来构建 OpenAPI 文档。

Implementations

impl OpenApiBuilder

pub fn new() -> Self

创建新的 OpenAPI 构建器

pub fn with_title_and_version( title: impl Into<String>, version: impl Into<String>, ) -> Self

创建指定标题和版本的 OpenAPI 构建器

pub fn title(self, title: impl Into<String>) -> Self

设置 API 标题

pub fn version(self, version: impl Into<String>) -> Self

设置 API 版本

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

设置 API 描述

pub fn terms_of_service(self, url: impl Into<String>) -> Self

设置服务条款 URL

pub fn contact(self, contact: Contact) -> Self

设置联系信息

pub fn license(self, license: License) -> Self

设置许可信息

pub fn path(self, path: impl Into<String>, item: PathItem) -> Self

添加路径

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

添加多个路径

pub fn schema(self, name: impl Into<String>, schema: Schema) -> Self

添加 Schema 组件

pub fn schemas(self, schemas: BTreeMap<String, Schema>) -> Self

添加多个 Schema 组件

pub fn response(self, name: impl Into<String>, response: Response) -> Self

添加响应组件

pub fn responses(self, responses: BTreeMap<String, Response>) -> Self

添加多个响应组件

pub fn parameter(self, name: impl Into<String>, parameter: Parameter) -> Self

添加参数组件

pub fn parameters(self, parameters: BTreeMap<String, Parameter>) -> Self

添加多个参数组件

pub fn request_body(self, name: impl Into<String>, body: RequestBody) -> Self

添加请求体组件

pub fn request_bodies(self, bodies: BTreeMap<String, RequestBody>) -> Self

添加多个请求体组件

pub fn security_scheme( self, name: impl Into<String>, scheme: SecurityScheme, ) -> Self

添加安全方案组件

pub fn security_schemes(self, schemes: BTreeMap<String, SecurityScheme>) -> Self

添加多个安全方案组件

pub fn server(self, url: impl Into<String>, description: Option<String>) -> Self

添加服务器

pub fn servers(self, servers: Vec<Server>) -> Self

添加多个服务器

pub fn tag(self, name: impl Into<String>, description: Option<String>) -> Self

添加标签

pub fn tags(self, tags: Vec<Tag>) -> Self

添加多个标签

pub fn external_docs( self, url: impl Into<String>, description: Option<String>, ) -> Self

设置外部文档

pub fn security(self, security: SecurityRequirement) -> Self

添加安全要求

pub fn securities(self, securities: Vec<SecurityRequirement>) -> Self

添加多个安全要求

pub fn build(self) -> OpenApiDoc

构建 OpenAPI 文档

Trait Implementations

impl Default for OpenApiBuilder

fn default() -> Self

创建默认的 OpenAPI 构建器