API
Как правильно документировать REST API
Хорошая API-документация сочетает машиночитаемый контракт, человеческие объяснения, запускаемые примеры и явное описание ошибок. У REST API-документации сразу две аудитории: машины и люди.
3 мин чтения
OpenAPI
Статьи с меткой: OpenAPI
API
OpenAPI — источник истины, но не вся API-документация
Описание OpenAPI позволяет генерировать точную структуру справочника, но разработчику всё равно нужны концепции, сценарии, аутентификация, примеры и восстановление после ошибок — то, чего одна схема объяснить не может. OpenAPI отлично описывает операции, параметры, структуры запросов и ответов, статус-коды и повторно используемые схемы.
3 мин чтения