/API-Portal

API Portal lets you create and publish a customized site with API documentation, for free and without writing any code.

Primary LanguageTypeScriptMIT LicenseMIT

API Portal

API Portal lets you create and publish a customized site with API documentation, for free and without writing any code. GitHub-based workflow enables collaboration between API providers and API consumers, source control, automation, and free hosting.

See the demo of a published API portal.

API Portal

Highlights

  • Modern API documentation portal. Create a modern API documentation portal with REST API reference pages, code samples, and interactive console. Customize it through a drag-and-drop, no-code visual editor.
  • GitHub-based API ecosystem. Create a GitHub-based API ecosystem for communication and collaboration between API providers and API consumers. Track source code changes, automate portal deployments with GitHub Actions, and host the site for free with GitHub Pages.
  • Enterprise-wide API catalog. Publish the portal within the organization to catalog APIs for discoverability, deduplication of assets, and business efficiency.
  • Branded API documentation portal. Publish the branded portal to partners or external consumers for discoverability and self-onboarding.
  • Proven technology. API Portal relies on the same technology as the Azure API Management’s developer portal (documentation, GitHub), which is used by thousands of Microsoft Azure customers.

Get started

The tutorial in the wiki section describes how to publish the first API, customize the portal, and publish it with GitHub Pages or your preferred hosting solution.