このページは、まだ日本語ではご利用いただけません。翻訳中です。
API Documentation
Konnect APIs can be documented with a tree of Markdown files, automatically generating URL slugs for the Dev Portal when published.
API Documentation is for a single API+version, to create portal-level content, use Custom Pages in the Portal Editor
Create a new API document
- Navigate to a specific API from APIs or Published APIs
- Select the Documentation tab
- Click New Document
- Select Start with a file and Upload a Markdown document, or Start with an empty document and provide the Markdown content.
Page structure
The slug
and parent
fields create a tree of documents, and builds the URL based on the slug/parent relationship. This document structure lives under a given API.
-
Page name: the name used to populate the
title
in the front matter of the Markdown document -
Page slug: the
slug
used to build the URL for the document within the document structure - Parent page: when creating a document, selecting a parent page creates a tree of relationships between the pages. This allows for effectively creating categories of documentation.
Example
-
API slug:
routes
-
API version:
v3
-
Page 1:
about
, parentnull
-
Page 2:
info
, parentabout
Generated URL for about
page: /apis/routes-v3}/docs/about
Generated URL for info
page: /apis/routes-v3}/docs/about/info
Publishing and visibility
When the document is complete, toggle Published on to make the page available on your portal, assuming all parent pages are Published as well.
- The Visibility of API documents are inherited from the API’s visibility and access controls.
- If a parent page is unpublished, all child pages will also be unpublished.
- If no parent pages are published, no API documentation will be visible, and the APIs list will navigate directly to generated specifications.