swagger-express-typescript
Version:
Generate and serve swagger.json
88 lines (87 loc) • 1.83 kB
TypeScript
export interface IApiOperationArgsBaseParameter {
name?: string;
description?: string;
type?: string;
required?: boolean;
format?: string;
minimum?: number;
maximum?: number;
default?: number;
deprecated?: boolean;
allowEmptyValue?: boolean;
}
export interface IApiPropertyBodyOperationArgsBaseParameter {
type: string;
required?: boolean;
}
export interface IApiBodyOperationArgsBaseParameter extends IApiOperationArgsBaseParameter {
properties?: any;
model?: string;
}
export interface IApiOperationArgsBaseResponse {
description?: string;
type?: string;
model?: string;
}
export interface IApiOperationArgsBaseParameters {
path?: {
[key: string]: IApiOperationArgsBaseParameter;
};
query?: {
[key: string]: IApiOperationArgsBaseParameter;
};
body?: IApiBodyOperationArgsBaseParameter;
formData?: {
[key: string]: IApiOperationArgsBaseParameter;
};
}
export interface IApiOperationArgsBase {
/**
* Define description
* Optional.
*/
description?: string;
/**
* Define summary
* Optional.
*/
summary?: string;
/**
* Define produces
* Optional.
*/
produces?: string[];
/**
* Define consumes
* Optional.
*/
consumes?: string[];
/**
* Define path
* Optional.
*/
path?: string;
/**
* Define parameters
* Optional.
*/
parameters?: IApiOperationArgsBaseParameters;
/**
* Define responses
*/
responses: {
[key: string]: IApiOperationArgsBaseResponse;
};
/**
* Define security
* Optional.
*/
security?: {
[key: string]: any[];
};
/**
* Define deprecated
* Optional.
*/
deprecated?: boolean;
}