refactor: move documentations to separete files

Author: DanielAraldi

src/main/docs/components.ts

@@ -0,0 +1,19 @@
+import { apiKeyAuthSchema } from './schemas/';
+import {
+  badRequest,
+  forbidden,
+  notFound,
+  serverError,
+  unanthorized,
+} from './components/';
+
+export default {
+  securitySchemes: {
+    apiKeyAuth: apiKeyAuthSchema,
+  },
+  badRequest,
+  serverError,
+  unanthorized,
+  notFound,
+  forbidden,
+};

src/main/docs/index.ts

@@ -1,28 +1,9 @@
-import { loginPath, surveyPath, signUpPath, surveyResultPath } from './paths';
-import {
-  badRequest,
-  serverError,
-  unanthorized,
-  notFound,
-  forbidden,
-} from './components';
-import {
-  loginParamsSchema,
-  errorSchema,
-  accountSchema,
-  surveyAnswerSchema,
-  surveySchema,
-  surveysSchema,
-  apiKeyAuthSchema,
-  signUpParamsSchema,
-  addSurveyAnswerSchema,
-  addSurveyParamsSchema,
-  saveSurveyParamsSchema,
-  surveyResultSchema,
-} from './schemas';
+import paths from './paths';
+import components from './components';
+import schemas from './schemas';
 
 export default {
-  openapi: '3.0.0', // API version
+  openapi: '3.0.0', // Swagger API version
   info: {
     title: 'Clean Node API',
     description:
@@ -39,34 +20,7 @@ export default {
   },
   servers: [{ url: '/api' }], // Paths URL
   tags: [{ name: 'Login' }, { name: 'Survey' }], // Query titles
-  paths: {
-    // API routes
-    '/login': loginPath,
-    '/signup': signUpPath,
-    '/surveys': surveyPath,
-    '/surveys/{surveyId}/results': surveyResultPath,
-  },
-  schemas: {
-    account: accountSchema,
-    loginParams: loginParamsSchema,
-    signUpParams: signUpParamsSchema,
-    error: errorSchema,
-    survey: surveySchema,
-    surveys: surveysSchema,
-    surveyAnswer: surveyAnswerSchema,
-    addSurveyAnswer: addSurveyAnswerSchema,
-    addSurveyParams: addSurveyParamsSchema,
-    saveSurveyParams: saveSurveyParamsSchema,
-    surveyResult: surveyResultSchema,
-  },
-  components: {
-    securitySchemes: {
-      apiKeyAuth: apiKeyAuthSchema,
-    },
-    badRequest,
-    serverError,
-    unanthorized,
-    notFound,
-    forbidden,
-  },
+  paths,
+  schemas,
+  components,
 };

src/main/docs/paths.ts

@@ -0,0 +1,9 @@
+import { loginPath, signUpPath, surveyPath, surveyResultPath } from './paths/';
+
+// API routes
+export default {
+  '/login': loginPath,
+  '/signup': signUpPath,
+  '/surveys': surveyPath,
+  '/surveys/{surveyId}/results': surveyResultPath,
+};

src/main/docs/schemas.ts

@@ -0,0 +1,27 @@
+import {
+  accountSchema,
+  loginParamsSchema,
+  signUpParamsSchema,
+  errorSchema,
+  surveySchema,
+  surveysSchema,
+  surveyAnswerSchema,
+  addSurveyAnswerSchema,
+  addSurveyParamsSchema,
+  saveSurveyParamsSchema,
+  surveyResultSchema,
+} from './schemas/';
+
+export default {
+  account: accountSchema,
+  loginParams: loginParamsSchema,
+  signUpParams: signUpParamsSchema,
+  error: errorSchema,
+  survey: surveySchema,
+  surveys: surveysSchema,
+  surveyAnswer: surveyAnswerSchema,
+  addSurveyAnswer: addSurveyAnswerSchema,
+  addSurveyParams: addSurveyParamsSchema,
+  saveSurveyParams: saveSurveyParamsSchema,
+  surveyResult: surveyResultSchema,
+};