OpenAPI Specification

The full API contract is maintained as an OpenAPI 3.x YAML file in the repository.

Download

Use with Swagger UI

npx @redocly/cli preview-docs \
  https://raw.githubusercontent.com/hideyukiMORI/nene-records/main/docs/openapi/openapi.yaml

Generate a client

# TypeScript (openapi-typescript)
npx openapi-typescript \
  https://raw.githubusercontent.com/hideyukiMORI/nene-records/main/docs/openapi/openapi.yaml \
  -o ./src/api/schema.d.ts

# Any language via openapi-generator
docker run --rm -v "$PWD:/local" openapitools/openapi-generator-cli generate \
  -i https://raw.githubusercontent.com/hideyukiMORI/nene-records/main/docs/openapi/openapi.yaml \
  -g python \
  -o /local/client

Validate locally

# Inside the NeNe Records repository
composer openapi

The CI pipeline runs OpenAPI validation on every pull request using tools/validate-openapi.php.