Use CasesPrivate API Reference

Private API Reference

Use internalpage when an API spec should be visible to your team but not exposed as a public developer portal.

Good fits:

  • internal service APIs
  • partner-facing specs before public release
  • PM and QA review links
  • generated OpenAPI specs from CI
  • API documentation for private pre-release environments

Create a private API reference:

npx @internalpage/cli auth login
npx @internalpage/cli pages create ./openapi.yaml --slug billing-api

Update the same reference when the spec changes:

npx @internalpage/cli pages update pg_xxx ./openapi.yaml

OpenAPI pages use a Redoc-based read-only viewer. internalpage validates that the uploaded file is an OpenAPI 3.x or Swagger 2.0 document with info.title.

This is intentionally not a full developer portal. It does not run API requests, collect API tokens, create mock servers, or generate SDKs.

Markdown DocsToken Handling