This API is part of the delivery system of the Omi Pali cafeteria, the API provides the stored information of the cafeteria users.
The data is stored in a relational database to improve query performance and maintain adequate structures.
The system is built with the Framework node JS and implementing the middleware express for the server, ORM sequelize for database management and if you want to switch from the Mysql database to another type of SQL database, it is compatible no need to make changes to the code and helmet to manage API security.
JSON web token is implemented for resource management and authentication measures to ensure that the data delivered corresponds to the user requesting it and to the token that it is using.
These instructions allow you to obtain a copy of the running project on your local machine for development and testing purposes.
The Rest-Api requires Node.js and TypeScript to run.
All available methods are found on the project documentation wiki along with the corresponding description. Documentation on github pages
Install the development and production dependencies and start the server.
$ git clone https://github.com/jquintanas/restApiSoftware1
$ cd restApiSoftware1
$ npm install
$ npm run build
$ npm run devAfter this we proceed to go to the config folder and open the file config.json and change the credentials of the database for those of our base server depending on the environment in which you are going to work.
- Express - back end middleware
- Sequelize - Database ORM
- JWT - JSON-based standard to create a token to send data between applications or services
Api-Rest requires the following complements.
| Complemento | Recurso |
|---|---|
| MySql-Schema | Descargar. |
| MySql - Model | Descargar. |
Author: Group #3
| Integrantes |
|---|
| BRENDA MICHELLE BERMELLO BURGOS |
| KARLA BELEN BURGOS GAYREY |
| FRANCESCA HELENA MAN GING POW HING |
| JONATHAN ISRAEL QUINTANA SOLORZANO |
| DANNY PAUL RIOS BENAVIDES |
This project is under the License (EULA) - see the file LICENSE for details.