About | Features | Technologies | Documentation | Requirements | Tests
API that shortens an url and save to the database.
This project is a part of a Mobile Development specialization course by Unyleya about NodeJS APIs made by Gian Carlo Mantuan Dala Rosa (me)
✔️ Shorten an URL;
✔️ Retrieve a shortened URL by its Identifier on the database;
✔️ Retrieve a list of shortened URLs given a date.
This project uses:
This project uses Swagger for its documentation. You can check the file swagger.yaml or access via /api-docs endpoint on the browser.
First you need NodeJS installed in your machine.
# Yarn
yarn install # To install the dependencies
yarn run dev # To run the porject
# NPM
npm install # To install the dependencies
npm run dev # To run the porject
You can run the command yarn test to run all of the api tests