- Add OpenApiDocs controller for serving bundled API docs - Split monolithic api-docs.yaml into modular components/ - Add organized paths/ directory with endpoint definitions - Create bundling scripts (JS, PHP, Python) for merging docs - Add API_DOCS_README.md with documentation guidelines - Update Routes.php for new API documentation endpoints - Update swagger.php view and TestDefSiteModel
43 lines
1.1 KiB
YAML
43 lines
1.1 KiB
YAML
/api/demo/hello:
|
|
get:
|
|
tags: [Demo]
|
|
summary: Hello world endpoint
|
|
description: Simple test endpoint that returns a greeting message
|
|
responses:
|
|
'200':
|
|
description: Successful response
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
status:
|
|
type: string
|
|
example: success
|
|
message:
|
|
type: string
|
|
example: Hello, World!
|
|
|
|
/api/demo/ping:
|
|
get:
|
|
tags: [Demo]
|
|
summary: Ping endpoint
|
|
description: Health check endpoint to verify API is running
|
|
responses:
|
|
'200':
|
|
description: API is running
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
status:
|
|
type: string
|
|
example: success
|
|
message:
|
|
type: string
|
|
example: pong
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|