An open API service indexing awesome lists of open source software.

https://github.com/youbaimkf/nest-auth-api

🛡️Auth API
https://github.com/youbaimkf/nest-auth-api

api authentication nestjs opaque-access-token swagger typescript

Last synced: 2 months ago
JSON representation

🛡️Auth API

Awesome Lists containing this project

README

          


Nest Logo

[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456

[circleci-url]: https://circleci.com/gh/nestjs/nest


NPM Version
Package License
NPM Downloads
CircleCI
Coverage
Discord
Backers on Open Collective
Sponsors on Open Collective

Support us


## API Description 🚀🤖

The API provides authentication functionalities for user registration, login, and token validation. It allows users to
register with a unique email address and password, authenticate themselves via login credentials, and validate access
tokens for authorized endpoints.

## Installation

```bash
$ npm install
```

## Running the app

```bash
# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod
```

![sample-api-swagger](public/sample-api-swagger.png)

## Test

```bash
# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov
```

## Logic

![nest-auth-api logic schema](public/nest-auth-api_LOGIC.png)