Skip to content

Latest commit

 

History

History
18 lines (14 loc) · 711 Bytes

DEVELOPMENT.md

File metadata and controls

18 lines (14 loc) · 711 Bytes

Testing

Prerequisites

  1. jq has been installed, ref: https://jqlang.github.io/jq/download/
  2. yq has been installed, ref: https://github.com/mikefarah/yq
  3. (If specify Git branch to retrieve OpenAPI specs from) gh has been installed, ref: https://github.com/cli/cli#installation
    • Once installed, set up your credentials via gh auth login
  4. redoc-cli has been installed, ref: https://github.com/Redocly/redoc
    • eg. npm install -g @redocly/cli

Validating API doc generation locally

  • Run ./test/test-multi-branch-doc-generation.sh.
  • Validate succeeds and can open the following API docs in a web browser:
    • docs/test/docs.html
    • docs/v1/docs.html
    • docs/v2/docs.html