From bbad00693a37e3ec09548b185272f6ef4bebf14f Mon Sep 17 00:00:00 2001 From: Nikita Melnikov Date: Tue, 24 Sep 2019 19:27:46 +0300 Subject: [PATCH] Add link to swagger.yaml --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d42b3ac..37146f7 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,12 @@ Open API — http-интерфейс для взаимодействия с то В Issues вы можете задать вопрос или найти ответ, если вопрос уже был задан другими пользователя. -В директории `src/` хранится документация в формате Markdown, если вы встретили неточность или хотели бы что-то дополнить, то мы будем рады принять от вас пулл реквест. Чтобы собрать документацию, необходимо выполнить `./build.sh`, после чего будет обновлена директория `docs/` +В директории `src/` хранится документация в формате Markdown, описание rest-протокола можно отредактировать в `src/docs/swagger-ui/swagger.yaml`. + +Если вы встретили неточность или хотели бы что-то дополнить, то мы будем рады принять от вас пулл реквест. + +Чтобы собрать документацию, необходимо выполнить `./build.sh`, после чего будет обновлена директория `docs/` + # Полезные библиотеки