Designing APIs with Swagger and OpenAPI

Эта книга — практическое руководство по проектированию и описанию API с использованием спецификации OpenAPI и инструментов Swagger. Авторы, имеющие богатый опыт в разработке API, проводят читателя через весь процесс: от создания первого определения OpenAPI до внедрения подхода design-first в команде.

Книга начинается с основ: что такое API, как работает OpenAPI, как использовать Swagger Editor для написания определений. Вы научитесь описывать ответы, создавать ресурсы, добавлять аутентификацию и авторизацию, а также готовить документацию для размещения.

Во второй части рассматривается подход design-first: проектирование веб-приложения, создание API-дизайна, построение рабочего процесса изменений, реализация фронтенда и бэкенда с использованием Node.js и Swagger Codegen, а также интеграция и выпуск приложения.

Третья часть посвящена расширению API: проектирование следующей итерации, композиция схем, масштабирование коллекций с фильтрами и пагинацией, обработка ошибок с problem+json, улучшение валидации с помощью JSON Schema и управление версиями API.

Книга содержит множество примеров, советов и лучших практик, которые помогут вам создавать качественные, хорошо документированные API, удобные для потребителей и разработчиков.