Struct OpenApiDoc 

pub struct OpenApiDoc {
    pub openapi: String,
    pub info: OpenApiInfo,
    pub paths: BTreeMap<String, PathItem>,
    pub components: Option<Components>,
    pub servers: Option<Vec<Server>>,
    pub tags: Option<Vec<Tag>>,
    pub external_docs: Option<ExternalDocumentation>,
    pub security: Option<Vec<SecurityRequirement>>,
}

OpenAPI 文档

Fields

openapi: String

OpenAPI 版本

info: OpenApiInfo

API 信息

paths: BTreeMap<String, PathItem>

路径定义

components: Option<Components>

组件定义

servers: Option<Vec<Server>>

服务器列表

tags: Option<Vec<Tag>>

标签列表

external_docs: Option<ExternalDocumentation>

外部文档

security: Option<Vec<SecurityRequirement>>

安全要求

Implementations

impl OpenApiDoc

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

创建新的 OpenAPI 文档

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

设置描述

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

添加路径

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

添加 Schema 组件

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

添加安全方案组件

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

添加响应组件

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

添加参数组件

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

添加请求体组件

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

添加服务器

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

添加标签

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

设置外部文档

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

设置安全要求

pub fn to_json(&self) -> Value

转换为 JSON

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.

impl Debug for OpenApiDoc

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for OpenApiDoc

fn default() -> Self

创建默认的 OpenAPI 文档

impl<'de> Deserialize<'de> for OpenApiDoc

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for OpenApiDoc

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.