diff --git a/src/Controllers/SheetController.ts b/src/Controllers/SheetController.ts index 63b65e7b5fd4bb1bd2843995afcbbcf3fb406d3b..cc094037d927661721d24b4a2fa8fbad37d3f410 100644 --- a/src/Controllers/SheetController.ts +++ b/src/Controllers/SheetController.ts @@ -3,7 +3,7 @@ import { } from 'express'; import { SheetParserResponse } from '../Models/SheetParserResponse'; import SheetService from '../Services/SheetService'; - +// import SwaggerSchemas from './Controllers/SwaggerSchemas'; const router = Router(); const parseSheet: Handler = async (req: Request, res: Response) => { @@ -17,36 +17,6 @@ const parseSheet: Handler = async (req: Request, res: Response) => { } }; -/** - * @swagger - * /excelParser: - * post: - * tags: - * - parser - * description: Sheet Parser - * requestBody: - * required: true - * content: - * application/json: - * schema: - * type: object - * required: - * - email - * - password - * properties: - * excel: - * type: string - * responses: - * '200': - * description: returns the parsed JSON of the excel file provided - * content: - * application/json: - * schema: - * type: object - * properties: - * excelParsed: - * type: string - */ router.post('/', parseSheet); export default router; diff --git a/src/Controllers/SwaggerEndpoints b/src/Controllers/SwaggerEndpoints new file mode 100644 index 0000000000000000000000000000000000000000..2a98cbbb04695d5c741d93c2511a9247ff3fa293 --- /dev/null +++ b/src/Controllers/SwaggerEndpoints @@ -0,0 +1,54 @@ +# /** +# * @swagger +# * components: +# * schemas: +# * Menores: +# * type: object +# * properties: +# * edad: +# * type: integer +# * peso: +# * type: integer +# * Mayores: +# * type: object +# * properties: +# * edad: +# * type: integer +# * peso: +# * type: integer +# * talla: +# * type: integer +# * SheetParserResponse: +# * type: object +# * properties: +# * hombresMenores: +# * type: Menores [] +# * +# * +# * mujeresMenores: +# * type: Menores [] +# * hombres: +# * type: Mayores [] +# * mujeres: +# * type: Mayores [] +# */ +/** + * @swagger + * /excelParser: + * post: + * tags: + * - parser + * description: Sheet Parser + * requestBody: + * required: true + * content: + * application/octet-stream: + * type: binary + * responses: + * '200': + * description: returns the parsed JSON of the excel file provided + * content: + * application/json: + * schema: + * $ref: '#/components/schemas/SheetParserResponse' + */ \ No newline at end of file diff --git a/src/Controllers/SwaggerSchemas b/src/Controllers/SwaggerSchemas new file mode 100644 index 0000000000000000000000000000000000000000..65d51f47a5c1dca0d8598e6c7e8dadb89d41ec8c --- /dev/null +++ b/src/Controllers/SwaggerSchemas @@ -0,0 +1,41 @@ +/** + * @swagger + * components: + * schemas: + * Menores: + * type: object + * properties: + * edad: + * type: integer + * peso: + * type: integer + * Mayores: + * type: object + * required: ["edad"] + * properties: + * edad: + * type: integer + * peso: + * type: integer + * talla: + * type: integer + * SheetParserResponse: + * type: object + * properties: + * hombresMenores: + * type: array + * items: + * $ref: '#/components/schemas/Menores' + * mujeresMenores: + * type: array + * items: + * $ref: '#/components/schemas/Menores' + * hombres: + * type: array + * items: + * $ref: '#/components/schemas/Mayores' + * mujeres: + * type: array + * items: + * $ref: '#/components/schemas/Mayores' + */ \ No newline at end of file diff --git a/src/index.ts b/src/index.ts index 52cbdc32127f805de68a2ef4a320b6f81501284e..fc61b0aa8b7c8148c56046decee194e94cdbc242 100644 --- a/src/index.ts +++ b/src/index.ts @@ -21,7 +21,7 @@ const swaggerOptions: Options = { servers: ['http://localhost:3000'], }, }, - apis: ['src/routes.ts'], + apis: ['src/Controllers/*'], }; const swaggerDocs = swaggerJsDoc(swaggerOptions);