v0.11.6
This commit is contained in:
+14
@@ -20,6 +20,18 @@ Content-Type: application/json
|
||||
|
||||
If `GREE_CONTROLLER_BASE_PATH=/gree` is configured, every HTTP and WebSocket path below is prefixed with `/gree`.
|
||||
|
||||
Interactive and machine-readable API documentation is served by the application itself:
|
||||
|
||||
```text
|
||||
GET /api-docs Swagger UI
|
||||
GET /api-docs/openapi.json OpenAPI 3.1 document
|
||||
```
|
||||
|
||||
The OpenAPI document contains endpoint descriptions, authentication schemes, parameters,
|
||||
request/response models, examples and common error responses. Its `servers` entry follows the
|
||||
configured `GREE_CONTROLLER_BASE_PATH`, so requests sent from Swagger UI target the current
|
||||
controller instance correctly.
|
||||
|
||||
## Authentication
|
||||
|
||||
There are three access levels.
|
||||
@@ -30,6 +42,8 @@ No token is required for:
|
||||
|
||||
```text
|
||||
GET /api/health
|
||||
GET /api-docs
|
||||
GET /api-docs/openapi.json
|
||||
GET /
|
||||
GET /index.html
|
||||
GET /app.js
|
||||
|
||||
+6905
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user