SwaggerDoc.d.ts 902 B

1234567891011121314151617181920212223242526
  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. static get(route: string): SwaggerDoc;
  13. static post(route: string): SwaggerDoc;
  14. private constructor();
  15. private setRoute;
  16. setSummary(summary: string): SwaggerDoc;
  17. setDescription(description: string): SwaggerDoc;
  18. setRequestBody(requestBody: SwaggerRequestBody): SwaggerDoc;
  19. addParameter(param: SwaggerParameter): SwaggerDoc;
  20. addResponse(res: SwaggerResponse): SwaggerDoc;
  21. toAnnotation(): string;
  22. private getMethod;
  23. private deserializeSchema;
  24. private repeatStr;
  25. }
  26. export { SwaggerDoc };