接口 ApiEndpoint<TParams, TResponse, TQuery, TBody>

API 端点定义

interface ApiEndpoint<
    TParams = unknown,
    TResponse = unknown,
    TQuery = unknown,
    TBody = unknown,
> {
    path: string;
    method: HttpMethod;
    description: string;
    tags: string[];
    params?: TParams;
    query?: TQuery;
    body?: TBody;
    response: TResponse;
}

类型参数

TParams = unknown
TResponse = unknown
TQuery = unknown
TBody = unknown

索引

属性

path method description tags params? query? body? response

属性

path

path: string

端点路径

method

method: HttpMethod

HTTP 方法

description

description: string

端点描述

tags

tags: string[]

端点标签/分类

`可选`params

params?: TParams

路径参数 schema

`可选`query

query?: TQuery

查询参数 schema

`可选`body

body?: TBody

请求体 schema

response

response: TResponse

响应 schema