Skip to content

openapi.md

Latest commit

 

History

History
35 lines (22 loc) · 881 Bytes

openapi.md

File metadata and controls

35 lines (22 loc) · 881 Bytes
Raw

OpenAPI

The API specification lives in openapi.yaml at the repository root.

OpenAPI (Swagger UI)
API overview Schemas
OpenAPI overview OpenAPI schemas list
Endpoint detail Schema models
OpenAPI GET /games/{id} OpenAPI schema detail

Swagger UI (included in Docker)

  • http://localhost:3035/ (dev and Ubuntu server use the same port)

Swagger Editor (browser)

  1. Open https://editor.swagger.io/
  2. File → Import file and select openapi.yaml

Local preview (optional)

npx --yes redoc-cli serve openapi.yaml

Base URL

  • API: http://localhost:3030/api (or http://<server-lan-ip>:3030/api on the network)