Документация API - это предоставляемый технический контент, содержащий инструкции о том, как эффективно использовать API и интегрироваться с ним. Это руководство, содержащее всю информацию, необходимую для работы с API, с подробными сведениями о функциях, классах, типах возвращаемых значений, аргументах и многом другом, подкрепленное руководствами и примерами.
Как использовать API
Например:
1. Перейдите в Меню -> заказы.
2. Включите режим разработчика с помощью имени пользователя в правом верхнем углу
3. Нажмите "Добавить заказ", и Система начнет добавлять сюда запросы и ответы.
Когда вы добавляете заказ, у вас есть пример того, что вы должны использовать для добавления заказа.
Затем, когда вы нажмете на колокольчик, вы увидите все действия и сможете нажать на них, чтобы увидеть подробную информацию ->
Swagger
Swagger позволяет вам описывать структуру ваших API-интерфейсов, чтобы машины могли их читать.
Способность API описывать свою собственную структуру является корнем всего удивительного в Swagger. Почему это так здорово? Что ж, прочитав структуру вашего API, мы сможем автоматически создавать красивую и интерактивную документацию по API. Мы также можем автоматически создавать клиентские библиотеки для вашего API на многих языках и изучать другие возможности, такие как автоматическое тестирование.
В интерфейсе pro нажмите на имя пользователя -> Документация API
