The development of this repo has been moved to the monorepo: https://github.com/BHelpful/BHelpful
This readme will explain the different parts of the API.
Below here is a diagram that shows the different types of parts of the API and how they connect.
This is where the endpoint descriptions for the API is located. It is here the different routes for the API is assigned to a function.
From here the each route will have access to use middleware and a controller. It is also here in the routes that the schema is used. The schemas are used to pass into the middleware called validateRequest, which will check if the request is valid basedn on the schema.
Middleware is a function that is called before a route is called. This means that middleware is a sort of basic validation check that is done before any sort of access to the database is given. An example of a middleware is the requiresUser middleware, which checks if the user is authenticated (logged in) before giving access to API calls that have something to do with a user, that should be logged in.
The controller is where the logic for the API is located. It is in here more complex logic in constructing the right data based on the request is located. The controller takes a request (req), processes the request using some logic and calls to the service, which handles access to the database. At last the controller returns the right data to the response (res).
The services are used to access the database. It is in here the functions defining the different types of querries to the database are defined. It is in here, that the different models (*model.ts) are used to access the database, as these define what parts of the database will be accessed and what kind of parameters will be accessable for each model.
At last there is the utils folder, which is used to define some utility functions. An example is JWT, which is used to handle a JWT tokens for the user's sessions.