apidoc_core/
operation.rs

1use serde::{Deserialize, Serialize};
2
3use super::{request::ApiRequest, response::ApiResponse};
4
5#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
6pub struct ApiOperation {
7    // 标识符
8    pub ident: String,
9
10    // 接口名称
11    pub name: Option<String>,
12
13    // 模块标识
14    pub module: String,
15
16    // 接口说明
17    pub note: Option<String>,
18
19    // 标签
20    pub tags: Vec<String>,
21
22    // 请求路径
23    pub path: String,
24
25    // 请求方式
26    pub method: Vec<String>,
27
28    // 请求信息
29    pub request: ApiRequest,
30
31    // 响应信息
32    pub response: ApiResponse,
33
34    // http | ws
35    pub protocol: String,
36}