Merge pull request #8 from mugarate12/feature/swagger

Feature/swagger

Author: mugarate12

CHANGELOG.md

@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.2.7] - 2022-10-26
+### Added
+- Add swagger to documentation application
+
 ## [1.2.6] - 2022-10-26
 ### Added
 - Add pino and pino-pretty to log to console

README.md

@@ -52,6 +52,8 @@ project
 │   nginx
 |   │   default.conf
 |   │   Dockerfile
+│   docs
+|   │   docs.yaml
 │   __tests__
 │   └───unit
 |   │   |  example.test.ts

package.json

@@ -1,6 +1,6 @@
 {
   "name": "basic-node-ts-config",
-  "version": "1.2.6",
+  "version": "1.2.7",
   "description": "Configuração básica para um ambiente de desenvolvimento com NodeJs + TypeScript",
   "main": "./lib/copyFile.js",
   "preferGlobal": true,

project/README.md

@@ -123,6 +123,8 @@ project
 │   nginx
 |   │   default.conf
 |   │   Dockerfile
+│   docs
+|   │   docs.yaml
 └───src
 |   |   app.ts
 |   |   server.ts

project/docs/docs.yaml

@@ -0,0 +1,48 @@
+openapi: 3.0.0
+info:
+  description: "This is a example of documentation to your API"
+  version: 1.2.7
+  title: Basic Code Ts Config
+  termsOfService: http://swagger.io/terms/
+  contact:
+    name: "Mateus Cardoso dos Santos"
+    email: serjumano17@gmail.com
+tags:
+  - name: example
+    description: Something
+    externalDocs:
+      description: Find out more
+      url: http://swagger.io
+      
+paths:
+  /:
+    get:
+      tags:
+        - example
+      summary: "Example to route docs"
+      description: "name value can be use your name to return message"
+      operationId: baseRoute
+      parameters:
+        - name: name
+          in: query
+          required: false
+          schema:
+            type: string
+            example: "Mateus"
+      responses:
+         "200":
+           description: "Successful request"
+           content:
+             application/json:
+               schema:
+                 type: object
+                 properties:
+                   message:
+                     type: string
+                     example: "API está funcionando!"
+           
+
+externalDocs:
+  description: Find out more about Swagger
+  url: http://swagger.io
+  

project/package-lock.json

@@ -38,7 +38,9 @@
     "pino": "^8.7.0",
     "pino-pretty": "^9.1.1",
     "redis": "^4.3.1",
-    "run-script-os": "^1.1.6"
+    "run-script-os": "^1.1.6",
+    "swagger-ui-express": "^4.5.0",
+    "yamljs": "^0.3.0"
   },
   "devDependencies": {
     "@babel/preset-env": "^7.19.1",
@@ -50,6 +52,7 @@
     "@types/jsonwebtoken": "^8.5.9",
     "@types/node": "^18.7.14",
     "@types/supertest": "^2.0.12",
+    "@types/yamljs": "^0.2.31",
     "jest": "^29.0.3",
     "nodemon": "^2.0.19",
     "supertest": "^6.2.4",

project/package.json

@@ -3,12 +3,17 @@ import cors from 'cors';
 import dotenv from 'dotenv';
 import http from 'http';
 import { errors } from 'celebrate';
+import swaggerUi from 'swagger-ui-express';
+import Yaml from 'yamljs';
 import path from 'path';
 
 import routes from './routes';
 
 dotenv.config();
 const applicationType = String(process.env.NODE_ENV);
+const swaggerDocument = applicationType === 'development' || applicationType === 'test' || applicationType === 'undefined' ?
+  Yaml.load(path.resolve(__dirname, '..', 'docs', 'docs.yaml')) :
+  Yaml.load(path.resolve(__dirname, '..', '..', 'docs', 'docs.yaml'));
 
 const app = express();
 const server = http.createServer(app);
@@ -27,6 +32,9 @@ app.use(express.json());
 // use all routes settings
 app.use(routes);
 
+// use swagger documentation
+app.use('/docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));
+
 // celebrate errors
 app.use(errors());