Struct OperationBuilder 

pub struct OperationBuilder { /* private fields */ }

操作构建器 — 描述单个 API 端点的元数据

Implementations

impl OperationBuilder

pub fn new() -> OperationBuilder

创建新的操作构建器

pub fn summary(&mut self, summary: &str) -> &mut OperationBuilder

设置摘要

pub fn description(&mut self, desc: &str) -> &mut OperationBuilder

设置详细描述

pub fn tag(&mut self, tag: &str) -> &mut OperationBuilder

添加标签（用于分组）

pub fn parameter( &mut self, name: &str, location: &str, desc: &str, required: bool, schema_type: &str, ) -> &mut OperationBuilder

添加参数

参数

• name：参数名
• location：参数位置（path / query / header / cookie）
• desc：参数描述
• required：是否必填
• schema_type：数据类型（string / integer / number / boolean / array）

pub fn response( &mut self, status: u16, desc: &str, content_type: &str, ) -> &mut OperationBuilder

添加响应

参数

• status：HTTP 状态码（如 200、404）
• desc：响应描述
• content_type：内容类型（如 "application/json"）

pub fn response_with_schema( &mut self, status: u16, desc: &str, content_type: &str, schema_ref: &str, ) -> &mut OperationBuilder

添加响应（带 schema 引用）

参数

• status：HTTP 状态码
• desc：响应描述
• content_type：内容类型
• schema_ref：schema 引用名（如 "#/components/schemas/User"）

pub fn deprecated(&mut self) -> &mut OperationBuilder

标记为已弃用

Trait Implementations

impl Default for OperationBuilder

fn default() -> OperationBuilder

Returns the “default value” for a type.