SwaggerDoc.d.ts 975 B

12345678910111213141516171819202122232425262728
  1. import { SwaggerParameter } from './SwaggerParameterType';
  2. import { SwaggerRequestBody } from './SwaggerRequestBodyType';
  3. import { SwaggerResponse } from './SwaggerResponseType';
  4. declare class SwaggerDoc {
  5. private method;
  6. private route?;
  7. private summary?;
  8. private description?;
  9. private requestBody?;
  10. private parameters;
  11. private responses;
  12. private security;
  13. static get(route: string): SwaggerDoc;
  14. static post(route: string): SwaggerDoc;
  15. private constructor();
  16. private setRoute;
  17. setSummary(summary: string): SwaggerDoc;
  18. setDescription(description: string): SwaggerDoc;
  19. setRequestBody(requestBody: SwaggerRequestBody): SwaggerDoc;
  20. addParameter(param: SwaggerParameter): SwaggerDoc;
  21. addResponse(res: SwaggerResponse): SwaggerDoc;
  22. addSecurityScheme(scheme: string): SwaggerDoc;
  23. toAnnotation(): string;
  24. private getMethod;
  25. private deserializeSchema;
  26. private repeatStr;
  27. }
  28. export { SwaggerDoc };