#14 Требования и документация к REST API. OpenAPI, Swagger

• Требования создаются до разработки и содержат описание структуры и логики работы методов REST API.  

• Требования могут быть описаны в свободной форме или по согласованному шаблону.  

• Документация REST API может быть создана вручную или автоматически с помощью инструментов, таких как Swagger.  

• Open API - это стандарт для описания спецификации REST API, определяющий формат спецификации и правила ее описания.  

• Swagger - это инструмент для автоматизированного документирования REST API на основе Open API.  

• JavaDoc - это инструмент для создания технической документации из комментариев в коде на Java.  

• Публичные REST API, такие как сервисы прогноза погоды, имеют подробно описанную документацию для пользователей.