michail93 / fabriq

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Разворачивание приложения

из директории в которой раходится manage.py запустите команду

docker-compose up

приложение и бд работают на 8000 и 5432 портах

Создание пользователя

Обращения к api происходит с использванием TokenAuthentication.

Для того чтобы создать пользователя отправьте POST запрос на url /api/get-token/ со следующим JSON

{
    "username": "<str>",
    "password": "<str>"
}

в ответ будет отправлен токен соданного пользователя

{
   "user_token": "<str>"
}

Обращения к api

  • Обращние к api позволяется только с использованием токена пользователя(HTTP зголовок Authorization)
Authorization: Token <str>
  • Создание приложения происходит методом POST по url /api/apps/ со следующим JSON
{
	"ID": <int>, 
	"name": "<str>"
}
  • Получение информации о приложении происходит методом GET по url /api/apps/pk/ где pk - id(pk) приложения
  • Обновление приложения происходит методами PUT и PATCH по по url /api/apps/pk/ где pk - id(pk) приложения со следующим JSON
{
	"ID": int, 
	"name": "<str>"
}
  • Удаление приложения происходит методом DELETE по url /api/apps/pk/ где pk - id(pk) приложения

  • Получение всей информации о приложении(в том числе и Ключа API) происходит по url /api/test/api_key/ где api_key - ключ api созданного приложения

  • Получить и установить ключ api можно при помощи метода create_api_key модели Application

About


Languages

Language:Python 97.8%Language:Dockerfile 1.3%Language:Shell 0.9%