Skip to content

Commit

Permalink
docs: short description of how to use it
Browse files Browse the repository at this point in the history
  • Loading branch information
Akay7 committed Jun 6, 2024
1 parent 82aa341 commit 03654b3
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,18 @@ docker compose -f compose.yml -f compose.local.yml up
docker compose -f compose.yml -f compose.local.yml run social-network-app python3 manage.py migrate
```

Access via browser to API
Access via browser to API docs

(http://localhost:8000/api/schema/swagger-ui/)[http://localhost:8000/api/schema/swagger-ui/]
1. [/api/schema/swagger-ui/](http://localhost:8000/api/schema/swagger-ui/)
2. [/api/schema/redoc/](http://localhost:8000/api/schema/redoc/)

It's exported to (Postman Collection)[https://www.postman.com/akay7/workspace/socialnetwork/overview]
It's also exported to [Postman Collection](https://www.postman.com/akay7/workspace/socialnetwork/overview)


## Nuances

API endpoints works for authenticated users apart from Login and Registration.

Authentication happened via JWT token.

JWT token possible to obtain via Registration or Login endpoints.

0 comments on commit 03654b3

Please sign in to comment.