https://github.com/dmitrykolyadin/notes-backend

https://github.com/dmitrykolyadin/notes-backend

Last synced: 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/dmitrykolyadin/notes-backend
• Owner: DmitryKolyadin
• Created: 2023-01-31T15:50:49.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-01-31T17:39:01.000Z (about 2 years ago)
• Last Synced: 2024-01-04T19:23:10.070Z (about 1 year ago)
• Language: Python
• Size: 7.81 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Notes-backend

Простой бекенд сервер для заметок на Django

### Методы

/api/v0.1/auth/login/password

/api/v0.1/notes

- GET — получение

- POST — создание

/api/v0.1/note

- GET — получение

- POST — обновление

- DELETE — удаление

### Краткая документация

#### /api/v0.1/auth/login/password

POST

Получение токена по паролю:

- username

- password

Возвращает:

```json

{

  "token": "JWT token",

  "ok": true,

  "error": null

}

```

#### /api/v0.1/new_user

POST

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

- first_name

- last_name

- username

- password

Возвращает:

```json

{

  "user_id": 123,

  "ok": true,

  "error": null

}

```

### ВАЖНО

Токен который был получен необходимо передавать в загаловках запроса в Authorization

#### /api/v0.1/notes

GET Получение заметок

Возвращает:

```json

{

  "notes": [

    {

      "id": 1,

      "title": "11"

    },

    ... ],

  "ok": true,

  "error": null

}

```

POST

Создание заметки:

- title

- text

Возвращает:

```json

{

  "id": 4,

  "ok": true,

  "error": null

}

```

#### /api/v0.1/note/1

GET - Получение заметки

Возвращает:

```json

{

  "note": {

    "id": 1,

    "title": "1",

    "text": "2"

  },

  "ok": true,

  "error": null

}

```

POST

Обновление заметки:

- title

- text

Возвращает:

```json

{

  "ok": true,

  "error": null

}

```

DEL - Удаление заметки

Возвращает:

```json

{

  "ok": true,

  "error": null

}

```