ABCDEFGHIJKLMNOPQRSTUVWXYZAA
1
Раздел спецификацииПараметрОтметка о выполненииКомментарий
2
Шапка спецификацииУказан автор спецификации
3
Указан дата создания/актуализации спецификации
4
Указана ссылка на задачу в тасктрекере
5
Указана ссылка на связанные спецификации
6
Указан статус спецификации
7
Указана версия разрабатываемого метода REST API
8
Общая информация о методеУказано назначение разрабатываемого метода REST API
9
Описано название микросервиса
10
Описано название HTTP метода
11
Описан способ авторизации/аутентификации (Bearer token,JWT,OAuth,API Key,OIDC,базовая аутентификация HTTP и тд)
12
Указано для каких ролей доступен разрабатываемый метод REST API*
13
Описание логики интеграцииОписана логика работы метода REST API
14
Описана логика преобразования данных в БД
15
Описано предложение по индексированию базы данных и/или по кэшированию **
16
Sequence диаграмма для описания взаимодействия компонентов*
17
Входные/выходные параметрыОписаны входные параметры (header,body, path, query).
По каждому парамету описаны:
1.название
2.описание
3.тип
4.обязательность
5.значение по умолчанию
6.пример значения
18
Описаны выходные параметры
По каждому парамету описаны:
1.название
2.описание
3.тип
4.обязательность
5.значение по умолчанию
6. источник данных для параметра (поле и таблица БД)
7.пример значения
19
Коды ответовКоды аварийных ответов
20
Коды успешных ответов
21
ПримерыПриведены примеры запросов/ответов
22
Приведены примеры интерфейсов с кратким описанием в какой момент происходит вызов разрабатываемого метода REST API*
23
Кэширование и пагинацияПредложения по кэшированию метода
24
Предложения по пагинации
25
* - При необходимости
26
** - Для высоконагруженных методов REST API
27
28
29
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