Interface APIDefine<T>

interface APIDefine<T> {
    before?: T[];
    body?: Record<string, ISchemaType>;
    description?: string;
    group?: string;
    handler?: T;
    headers?: Record<string, ISchemaType>;
    method: "delete" | "get" | "patch" | "post" | "put";
    middlewares?: T[];
    mock?: Record<string, any>;
    params?: Record<string, ISchemaType>;
    path: string;
    query?: Record<string, ISchemaType>;
    required?: string[];
    requiredOneOf?: string[];
    response?: TYPE_RESPONSE;
    title: string;
}

Type Parameters

  • T

Hierarchy (view full)

Properties

before? body? description? group? handler? headers? method middlewares? mock? params? path query? required? requiredOneOf? response? title

Properties

Optional before

before?: T[]

Optional body

body?: Record<string, ISchemaType>

Optional description

description?: string

Optional group

group?: string

Optional handler

handler?: T

Optional headers

headers?: Record<string, ISchemaType>

method

method: "delete" | "get" | "patch" | "post" | "put"

Optional middlewares

middlewares?: T[]

Optional mock

mock?: Record<string, any>

Optional params

params?: Record<string, ISchemaType>

path

path: string

Optional query

query?: Record<string, ISchemaType>

Optional required

required?: string[]

Optional requiredOneOf

requiredOneOf?: string[]

Optional response

response?: TYPE_RESPONSE

title

title: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc