Node URL Shortener API
nanoId for generating code for URLs Winston Logger Swagger and Document are available Jest and Supertest for End to end testing. Bcryptjs for hashing the password for more security. MongoDB for storing users and URLs.
for installing all dependencies open the terminal in that directory and run : npm install
open the terminal in that directory and run: npm start
open the terminal in that directory and run: npm test
POST /api/auth/signup
{ "email": "a valid email address", "password": "a strong valid password", }
{ "message": "user successfully created now you can log in with it!", }
POST /api/auth/login
{ "email": "a valid email address", "password": "a strong valid password", }
{ "message": "Congrats your in", "token": "a token generated with jsowebtoken", }
POST /api/url/shorten
Headers:{ Authorization:"token that given while logining" } { "longUrl": "a valid url", }
{ "urlCode": "code generated with shortid library", "longUrl": "your long url", "shortUrl": "generated short url", }
POST /api/url/
Headers:{ Authorization:"token that given while logining" }
[{ "urlCode": "code generated with shortid library", "longUrl": "your long url", "shortUrl": "generated short url", }, ]
DELETE /api/url/:code
Headers:{ Authorization:"token that given while logining" }
{ "message": "URL deleted!" }
GET /:code
Redirect to the original URL.
GET /api-docs
Going to the SwaggerUI page.
It has a folder with an error.log file for server logs.
you should rename .env.example to .env and complete it. It needs two mongoDB atlas URLs or local URLs, one for production data and one for testing. You should put your secret for the JSON web token too.