Проектирование веб-API

Содержание книги "Проектирование веб-API "

Предисловие
От автора
Благодарности
Об этой книге
Об авторе
Об иллюстрации на обложке
Часть I. Основы проектирование API
1. Что такое проектирование API
1.1. Что такое API?
1.2. Чем важна разработка API
1.3. Элементы проектирования API
2. Проектирование API для пользователей
2.1 Правильная точка зрения для проектирования повседневных пользовательских интерфейсов
2.2 Проектирование интерфейсов программного обеспечения
2.3 Определение целей API
2.4 Избегаем точки зрения поставщика при проектировании API
3. Проектирование программного интерфейса
3.1 Знакомство с REST API
3.2 Перенос целей в REST API
3.3 Проектирование данных API
3.4 Достижение баланса при решении проблем проектирования
3.5 Почему REST важен при проектировании любого API
4. Описание API с помощью формата описания
4.1 Что такое формат описания API?
4.2 Описание ресурсов и действий API с помощью OAS
4.3 Описание данных API с помощью OpenAPI и JSON Schema
4.4 Эффективное описание API с помощью OAS
Часть II. Проектирование практичного API
5. Разработка простого API
5.1 Разработка простых представлений
5.2 Проектирование простых взаимодействий
5.3 Проектирование простых потоков
6. Проектирование предсказуемого API
6.1 Согласованность
6.2 Адаптируемость
6.3 Быть видимым
7. Проектирование лаконичного и хорошо организованного API
7.1 Организация API
7.2 Определение размера API
Часть III. Контекстное проектирование API
8. Проектирование безопасного API
8.1 Обзор безопасности API
8.2 Разделение API на части для облегчения управления доступом
8.3 Проектирование с учетом управления доступом
8.4 Обработка конфиденциальных данных и важных вещей
9. Изменение дизайна API
9.1 Проектирование изменений API
9.2 Управление версиями API
9.3 Проектирование API с учетом расширяемости
10 Проектирование эффективного API для сети
10.1 Обзор проблем передачи данных по сети
10.2 Обеспечение эффективности передачи данных по сети на уровне протокола
10.3 Обеспечение эффективности передачи данных по сети на уровне дизайна
11 Проектирование API в контексте
11.1 Адаптация передачи данных к целям и характеру данных
11.2 Соблюдение полного контекста
11.3 Выбор стиля API в соответствии с контекстом
12. Документирование API
12.1 Создание справочной документации
12.2 Создание руководства пользователя
12.3 Предоставление адекватной информации разработчикам
12.4 Документирование изменений API и устаревшие функции
13. Развитие API
13.1 Жизненный цикл API
13.2 Создание руководства по проектированию API
13.3 Проверка API
13.4 Общайтесь и делитесь информацией