Developer portal
A developer portal is an online interface that centralizes documentation, discovery, access, and other resources or workflows for developers and API consumers.
Automating API Delivery
A developer portal is an online platform that provides API documentation, discovery, access, and related resources to API consumers.
- How it is used
- Publishes API reference documentation and supporting guidance for API consumers during the API product release process.
- 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 you can do after
- Operate Redocly CLI and an HTTP server to publish and inspect a browsable API reference.
Read how Automating API Delivery explains developer portal →
Effective Platform Engineering
A developer portal is a centralized interface for organizing developer documentation, resources, services, and engineering tools.
- How it is used
- Improves developer discoverability, collaboration, and access to platform capabilities through a centralized interface.
- How deep it goes
- Defines portal capabilities and contrasts them with IDP responsibilities, while deferring detailed orchestration and portal implementation.
- Examples
- Uses Backstage, LaunchPad, service registries, project templates, APIs, documentation, forums, and knowledge bases as concrete artifacts.
- What you can do after
- Build a proof of concept that integrates portal discoverability with IDP deployment and provisioning workflows.
Read how Effective Platform Engineering explains developer portal →
Microsoft Azure in Action
A developer portal is a web interface that provides API documentation, interactive endpoint testing, access credentials, and usage information for API consumers.
- How it is used
- Serves as the main public interface through which developers discover, test, authenticate to, and monitor an API.
- How deep it goes
- Defines capabilities and customization options, but stops short of detailed portal design or configuration procedures.
- Examples
- Uses a freshly generated portal to demonstrate documentation, design controls, endpoint testing, sign-up, and API-key acquisition.
- What you can do after
- Evaluate/understand how developers discover, test, authenticate to, and monitor an API through its public interface.
Read how Microsoft Azure in Action explains 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.
These guides are generated from the text of Manning books by Manning's knowledge graph and link to the sections they draw on. The full books are available on liveBook and at manning.com.