- Создать OAuth токен на GitHub.
Необходимо это для множественных запросов на сервер GitHub при установке
проекта через
composer
- Разместить полученный токен в файле
Dockerfile
вместоTOKEN_GITHUB
- Выполнить команды из корня проекта
docker-compose build docker-compose up -d docker-compose exec web composer install docker-compose exec web php yii migrate --interactive=0
- Запросы к API выполнять по адресу
localhost:8100
- GET
/position?id=<int>
получение шахматной позиции по номеру - POST
/position/create
создание новой шахматной позиции - PUT
/position/update?id=<int>
изменение шахматной позиции по номеру
Формат вода/вывода данных JSON
{
"id":4,
"name":"Название партии",
"positions":[
{"board":"a1","figure":"R","color":"w"},
{"board":"a2","figure":"p","color":"w"},
{"board":"b1","figure":"N","color":"w"},
{"board":"b2","figure":"p","color":"w"},
{"board":"c1","figure":"B","color":"w"}
]
}
Формат ввода аналогичен, кроме передачи id
номера партии при создании и редактировании
Поле name
не обязательно для заполнения и участвует только при создании новой партии,
все остальные поля обязательны для заполнения
Используемые сокращения
Фигуры (figure
):
K
- КорольQ
- ФерзьR
- ЛадьяN
- КоньB
- Слонp
- Пешка
Цвет фигуры (color
):
w
- белыйb
- черный