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 login
npx @internalpage/cli publish ./openapi.yaml --slug billing-api

Update the same reference when the spec changes:

npx @internalpage/cli publish ./openapi.yaml --slug billing-api

OpenAPI pages support ReDoc, Swagger UI, and Scalar as read-only renderers. ReDoc is the initial workspace default. Workspace owners can change that default, while each page can either follow it or keep a page-specific override.

internalpage validates that the uploaded file is an OpenAPI 3.x or Swagger 2.0 document with info.title. The original spec remains the page source, so you can change the renderer without republishing the file.

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