Project

General

Profile

APIForNG » History » Version 4

Denis Kildishev, 02/01/2021 12:55 PM

1 1 Denis Kildishev
h1. APIForNG
2 4 Denis Kildishev
3 1 Denis Kildishev
По текущей модели предполагается использование следующих методов:
4 2 Denis Kildishev
Для всех методов по умолчанию используется один заголовочный параметр
5
Authorization со значением Bearer 36AC0A0F7F271314B72986EB54DB2343
6 1 Denis Kildishev
7
1.Получение списка проектов
8
Method:
9
GET
10
Path:
11
http://localhost:9988/projects
12 2 Denis Kildishev
Без дополнительных параметров
13
Пример выдачи
14 1 Denis Kildishev
{
15
  "success" : true,
16
  "result" : {
17
    "projects" : [ "Example", "з1", "arch", "stpo"],
18
    "count" : 7
19
  }
20
}
21 2 Denis Kildishev
Без дополнительных параметров
22 1 Denis Kildishev
23 2 Denis Kildishev
2. Получение содержимого проекта(иерархия), для expandable - ограниченное 1м уровнем 
24 1 Denis Kildishev
Method:
25
GET
26
Path:
27 2 Denis Kildishev
http://localhost:9988/projects/{arch}[/expandable]
28
Здесь {arch} - имя проекта, на данный момент регистрозависимо
29
Без дополнительных параметров
30
Пример выдачи
31 1 Denis Kildishev
{
32
"success": true,
33
"result": {
34
"name": "arch",
35
"nodes": [
36
  {
37
"uuid": "243f4afe-1d28-4652-80b9-4ad123b415a4"
38
"name": "Documents",
39
"type": "DocFolder",
40
41
},
42
  {
43
"uuid": "7a5374ee-eb7a-4731-997d-5f52f00ebc2e"
44
"name": "Requirements",
45
"type": "Requirement",
46
"haveChildren":"true",
47
"children": [
48
  {
49
"uuid": "8ccd86e3-5689-43aa-9241-04728447e8f7",
50
"name": "001",
51
"type": "Requirement",
52
"children": [],
53
},
54
},
55
  {
56
"uuid": "ff42a6f4-f9ac-48c3-b41c-c36395df8a85",
57
"name": "Reports",
58
"type": "ReportFolder"
59
}
60
],
61
}
62
}
63
по умолчанию выдает все дерево с базовым набором из нескольких полей - уникального id uuid, отображаемого имени name, типа type и массива потомков children. 
64
поле haveChildren присутствует если у узла есть потомки и работает даже когда children не видны в режиме expandable для 2 уровня вложенности
65
при режиме [expandable] потомки выдаются до 1 уровня вложенности
66
67
3. Получение данных по поддереву
68
Method:
69
GET
70
Path:
71 2 Denis Kildishev
http://localhost:9988/projects/{TEST}/tree/ff42a6f4-f9ac-48c3-b41c-c36395df8a85[/expandable]
72
{TEST} - имя проекта
73 1 Denis Kildishev
id после /tree это id узла для которого получается поддерево, режим /expandable работает аналогично проекту
74 2 Denis Kildishev
Без дополнительных параметров
75 1 Denis Kildishev
Пример выдачи
76
{
77
"success": true,
78
"result": {
79
"uuid": "ff42a6f4-f9ac-48c3-b41c-c36395df8a85",
80
"name": "Reports",
81
"type": "ReportFolder"
82
}
83
}
84
Содержимое result аналогично описанию одного узла и всех его потомков[или потомков 1 уровня вложенности для expandable] в выдаче проекта
85
86
4. Получение свойств узлов
87
Method:
88
POST
89
Path:
90
http://localhost:9988/projects/TEST/getattributes/
91 2 Denis Kildishev
В теле запроса передаются все uuid ы узлов для которых нужно выдать свойства. Конкретная реализация пока уточняется, текущее предположение - просто передавать в текстовом виде с разделителем ;. Возможно будут передаваться в качестве массива по аналогии с передачей данных форм. Пример "4db0fbf4-f383-4740-9d72-891ef112f742;ff42a6f4-f9ac-48c3-b41c-c36395df8a85".
92
Пример выдачи
93 1 Denis Kildishev
{
94
"success": true,
95
"result": {
96
"4db0fbf4-f383-4740-9d72-891ef112f742":{
97
"Вид": {
98
"value": "",
99
"type": "STRING"
100
},
101
"_index": {
102
"value": "1",
103
"type": "STRING"
104
},
105
"_name": {
106
"value": "Хронология",
107
"type": "STRING"
108
},
109
"_type": {
110
"value": "Requirement",
111
"type": "STRING"
112
},
113
"_id": {
114
"value": "001",
115
"type": "STRING"
116
},
117
"ForeignID": {
118
"value": "1",
119
"type": "STRING"
120
}
121
},
122
"9dffaddf-a55a-4fa1-a3bc-4a5fade4169f":{
123
"Вид": {
124
"value": "Заголовок",
125
"enumName": "Вид",
126
"valueType": "STRING",
127
"type": "ENUM"
128
},
129
"_index": {
130
"value": "1",
131
"type": "STRING"
132
},
133
"_tags": {
134
"value": [
135
  {
136
"value": "section_Архитектура_ПО_Поток_управления"
137
}
138
],
139
"valuesType": "STRING",
140
"type": "LIST"
141
},
142
"_type": {
143
"value": "Requirement",
144
"type": "STRING"
145
},
146
"_id": {
147
"value": "Поток управления",
148
"type": "STRING"
149
},
150
"_description": {
151
"value": " ",
152
"type": "HTML"
153
},
154
"ForeignID": {
155
"value": "2",
156
"type": "STRING"
157
}
158
}
159
}
160
}
161
162
В примере выдача свойств двух узлов. Они расположены в result в виде словаря где ключ это id а значение - набор свойств узла.
163 3 Denis Kildishev
164
5. Метод для работы с ресурсами. Текущая реализация
165
Method:
166
GET
167
Path:
168
http://localhost:9988/projects/{TEST}/nodes/{n}/resources/{resFolder}/{res}
169
{Test} имя проекта
170
{n} - uuid узла
171
{resFolder} папка с ресурсами(внутри {node_id}_resources, например "images")
172
{res} имя файла
173
Возвращает ответ типа APPLICATION_OCTET_STREAM включающий в себя содержимое нужного ресурса. В теле также передается имя файла.
174
Если ресурса нет то выдается ответ NOT_FOUND типа plain text
175
Если передано некорректное имя папки с ресурсами(включающее недопустимые символы) то выдается ответ INVALID FOLDER типа plain text
176 4 Denis Kildishev
177
Предположительно появится метод получения ресурсов по списку для множества узлов но потом
178
Возможный формат передачи данных - json пары
179
{"uuid":"resfolder/resname","uuid2":"resfolder2/resname2"}
180
Возможный тип возвращаемого значения - multipart/mixed. Но при этом размер возвращаемых данных может оказаться значительным