Struct OpenAPIGenerator 

pub struct OpenAPIGenerator { /* private fields */ }

Implementations

impl OpenAPIGenerator

pub fn new() -> Self

pub fn with_info(self, info: Value) -> Self

pub fn register_path(&mut self, path: &str, info: PathInfo) -> &mut Self

注册 (path, method) 操作。同一 path 的多个 method 会合并到同一个 paths 条目。

pub fn register_schema(&mut self, name: &str, schema: Schema) -> &mut Self

注册可复用的 Schema 定义

pub fn register_security_scheme( &mut self, name: &str, scheme: SecurityScheme, ) -> &mut Self

注册可复用的 SecurityScheme

pub fn add_tag(&mut self, tag: Tag) -> &mut Self

添加接口分组标签

pub fn add_server(&mut self, server: Server) -> &mut Self

添加环境服务器

pub fn with_global_security(self, req: SecurityRequirement) -> Self

设置全局安全要求

pub fn generate(&self) -> OpenAPISpec

生成 OpenAPISpec

Trait Implementations

impl Default for OpenAPIGenerator

fn default() -> Self

Returns the “default value” for a type.