Azure
/
API-Portal
зеркало из https://github.com/Azure/API-Portal.git
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность
API Portal lets you create and publish a customized site with API documentation, for free and without writing any code.
5 коммитов 22 Ветки 3 Теги 57 MiB
TypeScript 58.2%
SCSS 23.7%
HTML 13.4%
Liquid 3.2%
JavaScript 1.5%
Перейти к файлу
Alexander Zaslonov 3caa073b8f
Added support for OpenAPI v3 schema rendering. (#5) 		2021-03-16 18:30:22 -07:00
.github/workflows Initial commit 2021-03-12 12:04:28 -08:00
data Added support for OpenAPI v3 schema rendering. (#5) 2021-03-16 18:30:22 -07:00
src Added support for OpenAPI v3 schema rendering. (#5) 2021-03-16 18:30:22 -07:00
.gitattributes Initial commit 2021-03-12 12:04:28 -08:00
.gitignore Initial commit 2021-03-12 12:04:28 -08:00
LICENSE Initial commit 2021-03-12 12:04:28 -08:00
README.md Readme refactoring (#3) 2021-03-16 13:46:37 -07:00
package-lock.json Added support for OpenAPI v3 schema rendering. (#5) 2021-03-16 18:30:22 -07:00
package.json Added support for OpenAPI v3 schema rendering. (#5) 2021-03-16 18:30:22 -07:00
postcss.config.js Initial commit 2021-03-12 12:04:28 -08:00
readme.gif Initial commit 2021-03-12 12:04:28 -08:00
tsconfig.json Initial commit 2021-03-12 12:04:28 -08:00
tslint.json Initial commit 2021-03-12 12:04:28 -08:00
webpack.build.js Initial commit 2021-03-12 12:04:28 -08:00
webpack.designer.js Initial commit 2021-03-12 12:04:28 -08:00
webpack.develop.js Initial commit 2021-03-12 12:04:28 -08:00
webpack.host.js Initial commit 2021-03-12 12:04:28 -08:00
webpack.publisher.js Initial commit 2021-03-12 12:04:28 -08:00
webpack.runtime.js Initial commit 2021-03-12 12:04:28 -08:00

README.md

API documentation portal

API documentation 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.

API Catalog

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 documentation 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 site, and deploy it with GitHub Pages.