REST API
Fourteen endpoints under /api/v1
Четырнадцать эндпоинтов под /api/v1
CRUD addresses a page by its path in the URL. Everything that needs a second
coordinate — a revision number or a diff range — takes the page as the
?path= parameter, so the routes stay unambiguous even for
a page named diff.
CRUD адресует страницу путём в URL. Всё, чему нужна вторая координата —
номер ревизии или диапазон diff — принимает страницу параметром
?path=, поэтому маршруты остаются однозначными даже для
страницы с именем diff.
# create a page
curl -X POST http://localhost:8080/api/v1/pages \
-H 'Content-Type: application/json' \
-d '{"path":"docs/setup","content":"# Setup\n","author":"n36"}'
# a ready patch between the previous and the current revision
curl 'http://localhost:8080/api/v1/diff?path=docs/setup&raw=1'
--- docs/setup@1
+++ docs/setup@2
@@ -1,4 +1,5 @@
# Setup
- Step one.
+ Step one, clarified.
+ Step three.
# создать страницу
curl -X POST http://localhost:8080/api/v1/pages \
-H 'Content-Type: application/json' \
-d '{"path":"docs/setup","content":"# Установка\n","author":"n36"}'
# готовый патч между предыдущей и текущей ревизией
curl 'http://localhost:8080/api/v1/diff?path=docs/setup&raw=1'
--- docs/setup@1
+++ docs/setup@2
@@ -1,4 +1,5 @@
# Установка
- Шаг один.
+ Шаг один, уточнённый.
+ Шаг три.