ABCDEFGHIJKLMNOPQRSTUVWXYZ
1
ЭтапПараметрОтметка о выполненииКомментарий
2
ПланированиеОзнакомился со всеми необходимыми документами по API на проекте
3
Участвовал в планировании и декомпозиции задачи на проектирование метода REST API
4
Выявлены все стейкхолдеры разрабатываемого метода REST API
5
Все стейкхолдеры приняли участвие в планировании задачи, дали свои оценки
6
По результату встреч по выявлению требований к разрабатываемому методу REST API регулярно рассылаются краткие итоги встреч
7
Внутри команды, разрабатывающей метод, есть понимание о последовательности и этапах работ
8
Внутри команды выработаны договоренности о том как нужно описывать методы REST API, например есть шаблон и описывающая его статья
9
АнализЛогика выполнения преобразования данных заложена на бэкэнде (на сервисе)
10
Логика, заложенная на разных типах клиентов (веб-приложение/android/ios) совпадает
11
Параметры ответа адаптированы под разные типы клиентов
12
Проведено уточнение нужна ли пагинация данных, которые возвращаются в ответе на проектируемый запрос
13
Проведен анализ нужно ли кешировать данные
14
Данные из полученного ответа должны кэшироваться полностью или нужно кэшировать лишь определенные параметры?
15
Для всех данных,для которых необходимо кэшировать описан способ и срок кэширования
16
Проведен анализ формата, в котором метод REST API должен предоставлять ответ клиенту, и формата, в котором данные хранятся на сервере.(на сервере может быть формат XML, а отдавать на клиент нужно например JSON)
17
Проведен анализ используются ли в проектируемом методе DTO, ранее выделенные в других методах REST API на текущем проекте.Если да, то лучше переиспользовать DTO.
18
Проведен анализ и из него понятно,что проектируемый методы будет высоконагруженным
19
ДокументированиеПроектируемый метод реально поектируется, а не был скопирован с описания другого метода без учета ограничений
20
Шаблон описания спецификаций, принятый на проекте, позволяет описать все необходимые требования к проектируемому методу REST API. При взгялде на шаблон у аналитика не возникает мыслей что в шаблоне не хватает важной информации
21
HTTP-глаголы использованы корректно
22
Описан способ авторизации/аутентификации
23
Описано назначение метода
24
Описана бизнес логика
25
Описаны входные/выходные параметры
26
Используемые коды ответов соответствуют логике https://ru.wikipedia.org/wiki/Список_кодов_состояния_HTTP
27
В документации на проектируемый метод REST API описаны примеры ответов и запросов. Примеры запросов корректно отформатированы
28
УтверждениеК валидации спецификации привлечен архитектор/тимлид/IT-лидер
29
Убедился, как разработчик понял написанную документацию на REST API
30
Проведено приемочное тестирование
31
Результаты тестирования оформлены так, чтобы любой участник команды мог ознакомиться с ними и при необходимости повторить тестирование
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100