https://github.com/sam016/phonebook-dotnet

https://github.com/sam016/phonebook-dotnet

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/sam016/phonebook-dotnet
• Owner: sam016
• Created: 2020-01-18T19:12:42.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-02-11T14:23:23.000Z (over 2 years ago)
• Last Synced: 2024-02-11T15:31:52.193Z (over 2 years ago)
• Language: C#
• Size: 2 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Phonebook API

Built using

1. .NetCore 3.1

2. MySQL

3. MediatR

4. AutoMapper

5. JWT Auth

6. Swagger

7. Docker

8. Uses the concepts of DDD (Domain Driven Design) and SOLID

## Running the Container

```bash

docker-compose up

```

Above mentioned commands starts

- .NetCore API Service

-  MySQL DB (seeded by default from `db.sql`)

## Access APIs

### Access Swagger documentation for the APIs

Browse to http://localhost:5000/swagger

### Execute APIs

#### `/api/auth/login`

Login using `john@example.com` and `password`

![Recording Auth](assets/Recording-Auth.gif)

#### `/api/auth/whoami`

Verify the logged in user details

Later, other endpoints can be used smoothly.

`/api/phonebooks` and `api/phonebooks/.../phone-entries` are protected and need authentication.

`/api/users` is open and doesn't need authentication

## Access Database

Browse to http://localhost:6001

    User: user

    Password: password

![ER Diagram](assets/phonebook-api-erd.png)

## TODO

1. Request Parameters Validation

2. Renew Token

3. Block Token (logout)

4. Pagination

5. Exception Handling

6. Logging