Open API documentation is available at https://examplehost:3000/api
Login and register endpoints are available to get an access token. This token is required to access the rest of the API. The token is valid for 7 days.
POST https://examplehost:3000/auth/login
-------
Body {email: string, password: string }
-------
Return {message: string, access_token: string}
For registration, the email must be unique and the password length must be strong enough. The password must contain an uppercase letter, a lowercase letter, a number and a special character.
POST https://examplehost:3000/auth/register
------
Body {name: string, email: string, password: string}
-------
Return {message: string, access_token: string}
Endpoints that require authentication must have the access token in the Authorization header of the request.
To use this API, you need to include your API key in the Authorization header of your requests.
Authorization: Bearer ACCESS_TOKEN
Add .env file with these variables:
- DATABASE_URL
- JWT_CONSTANT
- clientID
- clientSecret
- callbackURL
- MapsAPIKey
$ npm install# development
$ npm run start
# watch mode
$ npm run start:dev
# production mode
$ npm run start:prod# unit tests
$ npm run test
# e2e tests
$ npm run test:e2e
# test coverage
$ npm run test:covNest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.
- Author - Kamil Myśliwiec
- Website - https://nestjs.com
- Twitter - @nestframework
Nest is MIT licensed.