Developer portal

As explained in Automating API Delivery

A developer portal is an online platform that provides API documentation, discovery, access, and related resources to API consumers.

A developer portal is the authoritative destination where API consumers find API reference documentation, user guides, and tutorials. It explains supported operations and helps developers begin using an API. section 6.2.3 section 1.4

A portal can be delivered through several arrangements:

• Upload generated API reference documentation to a developer portal service. section 6.2.3
• Use the portal supplied with an API gateway platform. section 6.2.3
• Build and serve a custom portal. section 6.2.3

Generate and serve an API reference

Generate a static, zero-dependency HTML reference from the API definition SOT with Redocly CLI: redocly build-docs product-catalog-v1-0.oas.yaml --output dev-portal/reference.html. Serve the dev-portal folder with http-server --port 9000, then open http://localhost:9000/reference.html. The generated three-panel layout provides search and navigation, but changes to the source definition require republishing to keep documentation synchronized with the API. section 6.2.3 section 1.6

Figure 6.6 Publish your OpenAPI definition as an API reference on your developer portal.

Shows the publication flow from an OpenAPI definition to an API reference on a developer portal. section 6.2.3

How Automating API Delivery covers it

How deep it goes

Defines portal contents and walks through static reference generation and serving, while deferring portal-service implementation and ongoing synchronization.

Examples

Uses a product-catalog OpenAPI definition, Redocly CLI, generated HTML, and a local HTTP server.

What it assumes

Assumes an API definition SOT and installed Redocly CLI, while explaining portal purpose and publication from the workflow.

What you can do after

Operate Redocly CLI and an HTTP server to publish and inspect a browsable API reference.

How it connects

Connects API consumers, API definitions, API references, API gateways, and the OpenAPI Specification.

liveBookmanning.com

Read Automating API Delivery on liveBook Get the book at manning.com

Also explained in

• 

  liveBookmanning.com
  Effective Platform EngineeringA developer portal is a centralized interface for organizing developer documentation, resources, services, and engineering tools.
• 

  liveBookmanning.com
  Microsoft Azure in ActionA developer portal is a web interface that provides API documentation, interactive endpoint testing, access credentials, and usage information for API consumers.

Compare how 3 books explain developer portal →

Related concepts

• internal developer platformcontrasts with · An internal developer platform is an organization-provided system of self-service interfaces, automation, abstractions, and reusable capabilities that supports software development and operation.
• websitekind of · A website is a collection of related web pages and resources made accessible through the web under a common site identity or address.
• Azure API Managementpart of · Azure API Management is a managed Azure service for publishing, securing, transforming, monitoring, analyzing, and distributing APIs.
• api catalogalternative to · An API catalog is a maintained, searchable inventory that documents an organization's APIs and enables their discovery and understanding.
• clientuses · A client is a person, organization, device, or software component that receives or uses a product, service, resource, or functionality provided by another entity.

This explainer was generated by Manning's knowledge graph from the text of Automating API Delivery. The section links point to the parts of the book it draws on.