Skip to content

Commit

Permalink
Update README.md added api doc
Browse files Browse the repository at this point in the history
  • Loading branch information
JohnGrat authored Apr 12, 2024
1 parent 53d39c5 commit 59598e0
Showing 1 changed file with 65 additions and 0 deletions.
65 changes: 65 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,68 @@ It uses the Mantine component library, React-router-guards, and Axios.

![Alt Text](https://i.imgur.com/cDbhevV.gif)
![WestCoastEdu](https://github.com/JohnGrat/WestCoastEducation/assets/51702387/f17924d5-7a6c-44cf-acfb-410d04f3e3db)

# API Documentation

AUTH
/api/auth/register-admin:
Method: POST
Description: Register a new admin user.
Authorization: User must have Admin role.
Tags: Authentication

/api/auth/revoke-all:
Method: POST
Description: Revoke all tokens for all users.
Authorization: User must have Admin role.
Tags: Authentication

/api/auth/revoke/{username}:
Method: POST
Description: Revoke all tokens for a specific user.
Parameters:
- username: The username of the user whose tokens are to be revoked.
Authorization: User must have Admin role.
Tags: Authentication

/api/auth/refresh-token:
Method: POST
Description: Refresh authentication token.
Tags: Authentication

/api/auth/logout:
Method: GET
Description: Logout the current user.
Authorization: Required
Tags: Authentication

/api/auth/googleexternallogin:
Method: GET
Description: Perform login via Google.
Tags: Authentication

/api/auth/login:
Method: GET
Description: Login to the system for using API User.
Tags: Authentication

/api/auth/me:
Method: GET
Description: Get current user details.
Authorization: Required
Tags: Authentication



BOOKS
/api/book:
Method: GET
Description: Get all books.
Tags: Books

/api/book/{id}:
Method: GET
Description: Get a specific book by ID.
Parameters:
- id: The unique identifier of the book.
Tags: Books

0 comments on commit 59598e0

Please sign in to comment.