Oliver Sand
774a000729
* docs(api-docs): add details to readme * docs: fix wrong markdown in readme files
1.3 KiB
1.3 KiB
API Documentation
WORK IN PROGRESS
This is an extension for the catalog plugin that provides components to discover and display API entities. APIs define the interface between components, see the system model for details. They are defined in machine readable formats and provide a human readable documentation.
The plugin provides a standalone list of APIs, as well as an integration into the API tab of a catalog entity.
Right now, the following API formats are supported:
Other formats are displayed as plain text, but this can easily be extented.
To fill the catalog with APIs, provide entities of kind API.
To link that an component implements an API, see implementsApis property on components.