add swagger

Author: Lissone

README.md

@@ -45,10 +45,12 @@ For the development of this project, a flowchart was created as application docu
 ## Technologies
 
 ### Backend (Api)
-* Express
+* Nodejs
 * Typescript
-* Firebase (database)
+* Express
+* Firestore
 * Jwt authentication
+* Swagger
 
 ### Front End
 * NextJs

packages/api/package.json

@@ -21,6 +21,7 @@
     "firebase": "^8.6.8",
     "jsonwebtoken": "^8.5.1",
     "reflect-metadata": "^0.1.13",
+    "swagger-ui-express": "^4.1.6",
     "uuid": "^8.3.2"
   },
   "devDependencies": {
@@ -30,6 +31,7 @@
     "@types/express": "^4.17.12",
     "@types/jsonwebtoken": "^8.5.3",
     "@types/node": "^15.14.0",
+    "@types/swagger-ui-express": "^4.1.3",
     "@types/uuid": "^8.3.0",
     "@typescript-eslint/eslint-plugin": "^4.28.1",
     "@typescript-eslint/parser": "^4.28.1",

packages/api/src/adapters/controllers/pokemonController.ts

@@ -50,7 +50,7 @@ class PokemonController {
       const pokemon = await this.repository.getOne(id, user, true)
 
       if (pokemon === undefined) {
-        res.status(500).send({ message: 'Pokemon not found' })
+        res.status(404).send({ message: 'Pokemon not found' })
         return
       }
 

packages/api/src/external/app.ts

@@ -1,7 +1,9 @@
 import express from 'express'
 import bodyParser from 'body-parser'
 import cors from 'cors'
+import swaggerUi from 'swagger-ui-express'
 
+import * as swaggerDocument from '../swagger.json'
 import { apiRoutes } from './routes'
 
 const app = express()
@@ -30,8 +32,6 @@ app.use(cors(options))
 
 app.use(apiRoutes)
 
-app.get('/', (req, res) => {
-  res.send({ message: 'API' })
-})
+app.use('/', swaggerUi.serve, swaggerUi.setup(swaggerDocument))
 
 export { app }