Описание API

Gramax показывает документацию по спецификации API прямо в статье — собственным компонентом. Для этого кликните в панели редактирования → OpenAPI. Поддерживается спецификация API в формате YAML.

Компонент умеет искать по операциям, показывает понятные ошибки в спецификации и позволяет выполнять запросы к API прямо из статьи.

Если спецификация разбита на несколько YAML-файлов со ссылками $ref на внешние файлы, Gramax подгружает и отображает их все, включая вложенные ссылки — объединять спецификацию в один файл не нужно.