Providing references to the relevant portal to an APIs operation, providing access to the landing page for the wider company, operations, as well as just for individual APIs when it makes sense--helping connect the wider ecosystem surrounding each API being delivered.

Also known as: Developer Portal, DevHub, API Hub

Example

- type: Portal
  url: https://portal.example.com/

Standards

• IETF RFC 8631 — Link Relation Types for Web Services
• IETF RFC 8288 — Web Linking
• schema.org schema.org WebSite
• CNCF Backstage Software Catalog

OpenAPI Expression

• info.contact.url (OpenAPI 3.x) — Frequently set to the developer portal landing page.
• externalDocs.url (OpenAPI 3.x) — Points to portal-hosted long-form documentation.

Link Relations

• service-desc — RFC 8631
• service-doc — RFC 8631
• service-meta — RFC 8631
• status — IANA

Governance Rules

• oas-info-contact (Spectral built-in) — Portal URL is a common value for info.contact.url.
• oas-external-docs (Spectral built-in) — externalDocs should reference the portal's docs section.

Risk & Compliance

Security: Developer portals often combine marketing pages with authenticated key management. Treat the authenticated app/keys area with the same care as a console — MFA, session management, audit logs — and isolate it from the public marketing CMS.

Tools

• Backstage — Internal developer portal (Apache-2.0)
• Tyk Developer Portal — API gateway portal
• Kong Developer Portal — API gateway portal
• Apigee Developer Portal — API management portal
• Azure API Management Developer Portal — API management portal
• Readme.com — Hosted developer hub

Suggested Metrics

• portal_signups — New developer accounts created in the portal per period.
• time_to_first_call_p50 — Median time from signup to first successful API call originated from a portal-issued key.
• docs_search_no_results_rate — Share of portal-search queries that return zero results — a content-gap signal.
• key_rotation_rate — Portion of active keys rotated within policy interval.

Example Implementations

• Stripe — Dashboard + docs portal at stripe.com/docs with workbench tooling.
• Twilio — Console + docs portal with project-scoped credentials.
• GitHub — docs.github.com plus the developer settings area for tokens and apps.
• Google — Google Cloud Console as the portal for API enablement and credentials.

Related Properties

• Portals
• Documentation
• Sign up
• Login
• Sdks

Tags

• Portals
• Landing Pages

All Common Properties