Skip to content

Commit cd48ec0

Browse files
committed
README - Update API Generator Section
1 parent c33f017 commit cd48ec0

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -163,12 +163,17 @@ This module helps to generate secure APIs using DRF via a simple workflow:
163163
- Access the API in the browser:
164164
- `/api/MODEL_NAME/`
165165

166-
The API is secured using the JWT mechanism provided by DRF.
166+
The API is secured using the JWT token provided by `/login/jwt/` request (username & password should be provided).
167167

168168
- GET requests are public (GET all, get Item)
169169
- Mutating requests are protected by token generated based on the user credentials (`username`, `pass`).
170170

171-
> A POSTMAN Collection Sample can be found [here](./media).
171+
> Two POSTMAN Collections are provided in the `media` directory:
172+
173+
- [Books API](./media/api-books.postman_collection) - that uses PORT **5000* for the api
174+
- [Books API 2](./media/api-books-docker.postman_collection) - that uses PORT **5085* for the api (default port in Docker)
175+
176+
In case both port are unusable in your environment, feel free to edit the files before POSTMAN import.
172177

173178
<br />
174179

0 commit comments

Comments
 (0)