Prova API

Descripció

Una API bàsica desenvolupada en Node.js amb TypeScript, utilitzant Express i Mongoose per a la gestió de dades en MongoDB. A més, s'inclou documentació amb Swagger.

Requisits previs

Abans d'executar el projecte, assegura't de tenir instal·lat:

• Node.js
• MongoDB

Instal·lació

Clona el repositori i executa la següent comanda per instal·lar les dependències:

npm install

Configuració

Crea un fitxer .env a la arrel del projecte i defineix les següents variables d'entorn//canviar les strings directament en el codi a les línies 16 (Port) i 69 (uri mongo) :

MONGO_URI=mongodb://localhost:27017/la_teva_base_de_dades
PORT=9000

Execució

Per iniciar l'API (tsc + cd ./build + node server.js):

npm start

Documentació

Swagger està disponible a:

http://localhost:9000/api-docs

Dependències Principals

• dotenv: Gestió de variables d'entorn.
• mongodb i mongoose: Base de dades MongoDB.
• swagger-jsdoc i swagger-ui-express: Generació de documentació.
• express: Framework per a l'API.

Dependències de Desenvolupament

• typescript: Suport per a TypeScript.
• @types/*: Definicions de tipus per a biblioteques utilitzades.