Документирование API¶
Для документирования API см. скриншот ниже:
Ниже перечислены типы документации, поддерживаемые в API Publisher:
-
Встроенный: размещает документацию (руководство по эксплуатации, примеры, SDK, форумы и т.д.) в самом NEOMSA APIM API Publisher и позволяет редактировать ее непосредственно через пользовательский интерфейс.
-
URL: Ссылки на публичные форумы, форумы поддержки или ссылки на файлы (URL) внешней системы управления конфигурацией.
-
Файл: позволяет загружать документацию непосредственно на сервер.
-
Markdown: позволяет добавлять документацию в формате markdown (.md) через редактор Markdown.
