Как документировать сгенерированные API Gateway SDK - PullRequest
0 голосов
/ 01 октября 2018

При создании API с помощью API Gateway вы можете указать документы, которые будут опубликованы с вашим API.

Из API Gateway вы можете создавать SDK (например, для iOS).Эти сгенерированные SDK создаются без какой-либо документации.

Разработчики iOS или Android могли бы использовать документы API, поскольку сгенерированный SDK на самом деле является всего лишь оберткой, но было бы проще иметь в коде собственные документы.

Myвопрос: Существует ли официальный способ документирования этого сгенерированного SDK, или вам нужно просматривать каждый сгенерированный файл для документирования классов, методов и моделей каждый раз, когда вы выпускаете новую версию?

...