leon.hoppe/HopFrame
1
0
Fork 0
Code Issues 2 Pull Requests Actions Packages Projects 1 Releases Wiki Activity

added docs for admin pages and blazor pages + fixed typos

Browse Source
This commit is contained in:
Leon Hoppe
2024-11-22 14:04:15 +01:00
parent 16ef41800d
commit 0c2c02136d
5 changed files with 156 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/api/endpoints.md
View File

@@ -8,14 +8,14 @@ HopFrame currently only supports endpoints for authentication out of the box.
> **Hint:** you can use the build-in [swagger](https://swagger.io/) ui to explore and test all endpoints of your application __including__ HopFrame endpoints.
### SecurityController
Base endpoint: `api/v1/authentication`\
Base endpoint: `/api/v1/authentication`\
**Important:** All primitive data types (including `string`) are return as a [`SingleValueResult`](./models.md#SingleValueResult)
| Method | Endpoint | Payload | Returns |
| ------ | -------- | ------- | ------- |
| PUT | login | [UserLogin](./models.md#UserLogin) | access token (string) |
| POST | register | [UserRegister](./models#UserRegister) | access token (string) |
| GET | authenticate | | access token (string) |
| DELETE | logout | | |
| DELETE | delete | [UserPasswordValidation](./models.md#UserPasswordValidation) | |
| Method | Endpoint | Payload | Returns |
|--------|---------------|--------------------------------------------------------------|-----------------------|
| PUT | /login | [UserLogin](./models.md#UserLogin) | access token (string) |
| POST | /register | [UserRegister](./models#UserRegister) | access token (string) |
| GET | /authenticate | | access token (string) |
| DELETE | /logout | | |
| DELETE | /delete | [UserPasswordValidation](./models.md#UserPasswordValidation) | |