REST API

This module was established to learn REST API basic principles. The project contains app written in TypeScript, unit tests and integration tests.

Table of Contents

• Description
• Instalations
• Usage
• Testing with Thunder Client
• Folder structure

Description

The Task Manager REST API may be used by frontend applications to manage everyday tasks. All endpoints are documented with Swagger and can be found at http://localhost:4001/api-docs/ after running the application in docs mode.

Instalations

Tu use the library you can clone the repository and install all dependencies.

git clone https://github.com/konrad-winnicki/rest-api

npm install

In the production, application connect to MongoDB Atlas. In the development mode it uses a MongoDB database started on the localhost. Thus, to use dev mode you need to download and install MongoDB. All necessary configurations for transpilation and testing you will find in tsconfig.json and package.json, respectively.

If you prefere run Docker container you can use services defined in docker-compose.yaml file by typing in root directory:

docker compose up mongodb -d 

Usage

First you have to prepare .env file in project root directory. The following key-value pairs must be defined:

SSLKEY='path to file with certificate'
SSLCERT='path to file with certificate'
DATABASE_URI_PROD='uri to database'
DATABASE_URI_DEV='mongodb://127.0.0.1:27017/taskManager'
DATABASE_URI_TEST='mongodb://127.0.0.1:27017/test'
TOKEN_SIGNATURE='9c7103c5-41a7-4383-92f9-d68ec50b2975'
PORT='4001'

Before tests, building API doc and running application you have to transpile TypeScript to JavaScript.

Project contains several predefined scripts which can be initialized with npm run and:
build : to transpile TypeScript to JavaScript
start : to start the server in the production
dev : to start server in development mode
test : to start all tests test
docs : to start building API documentation on the localhost.

Important: docs command will also run all tests.

Example:

npm run docs

Testing with Thunder Client

For testing Thunder Client can be also used. You can find it in extensions for VCS. In the project root folder you can find thunder-collection_restapi.json to import as Collections and thunder-environment_variables.json to import es Env.

Folder structure

src/
│   app.ts
│   startServer.ts
│   tree.txt
│   
├───Common
│   └───Infrastructure
│       │   DatabaseConnector.ts
│       │   dependencias.ts
│       │   ErrorHandler.ts
│       │   HttpResponse.ts
│       │   
│       └───Middlewere
│               userAuthorizer.ts
│               
├───Task
│   ├───Application
│   │       TaskRepositoryInterface.ts
│   │       TaskService.ts
│   │       
│   ├───Domain
│   │       InputTask.ts
│   │       Task.ts
│   │       TaskSorter.ts
│   │       
│   └───Infrastructure
│           MongoTaskRepository.ts
│           taskControllers.ts
│           v1taskRouter.ts
│           
├───User
│   ├───Application
│   │       UserRepositoryInterface.ts
│   │       UserService.ts
│   │       
│   ├───Domain
│   │       InputUser.ts
│   │       User.ts
│   │       
│   └───Infrastructure
│           MongoUserRepository.ts
│           userControllers.ts
│           v1userRouter.ts
│           
└───__tests__
        api.test.ts
        InputTask.test.ts
        InputUser.test.ts
        Task.test.ts
        TaskSorter.test.ts