API

HoyoShip’s API is documented via Swagger/OpenAPI v2. Each instance serves the raw JSON file at /swagger.v1.json, for example https://hoyoship.example.org/swagger.v1.json. A human readable UI for the swagger file is served at /api/swagger, for example https://hoyoship.example.org/api/swagger.

Using the API is furthermore documented in API Usage.