https://github.com/26remph/api_final_yatube
REST API для проекта 'социальная сеть Yatube', git: https://github.com/26remph/hw05_final
https://github.com/26remph/api_final_yatube
django-rest-framework pillow rest-api
Last synced: 3 months ago
JSON representation
REST API для проекта 'социальная сеть Yatube', git: https://github.com/26remph/hw05_final
- Host: GitHub
- URL: https://github.com/26remph/api_final_yatube
- Owner: 26remph
- License: mit
- Created: 2022-05-16T06:47:58.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2022-05-19T17:51:27.000Z (about 4 years ago)
- Last Synced: 2025-12-31T21:16:15.369Z (6 months ago)
- Topics: django-rest-framework, pillow, rest-api
- Language: Python
- Homepage:
- Size: 53.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Финальная версия API, в которой применены все знания теоретической части по теме
django-rest-framework. [Yatube](http://vidim.pythonanywhere.com/) - это социальная сеть для публикации своих постов. Поддерживает разные тематические группы. Авторство и подписки.
___
## Оглавление
0. [Как запустить проект](#как-запустить-проект)
1. [Создание пользователей](#cоздание-пользователей)
2. [Документация по api для yatoube](#документация-по-api)
3. [Поиск в базе данных](#поиск-в-базе-данных)
4. [Демонстрационная версия API](#Демонстрационная-версия-API)
5. [Об авторе](#об-авторе)
6. [Контрольная сумма репозитария](#контрольная-сумма-проекта)
### Как запустить проект
- клонировать репозиторий и перейти в него в командной строке:
```
git clone https://github.com/yandex-praktikum/kittygram.git
cd kittygram
```
- создать и активировать виртуальное окружение:
```md
python3 -m venv env
source env/bin/activate
```
- установить зависимости из файла requirements.txt:
```
python3 -m pip install --upgrade pip
pip install -r requirements.txt
```
- выполнить миграции:
```
python3 manage.py migrate
```
- запустить проект:
```
python3 manage.py runserver
```
### Создание пользователей
Создание пользователей через API не предусмотрено. Работа с API доступна, только авторизированным пользователям через JSON WEB Token (JWT). Как получить и установить токен [читайте ниже](#авторизация-API-пользователей).
Для создания пользователей имеющих доступ к API вам необходимо созадать суперпоьзователя и войти под ним в админ панель.
Для создания суперпользователя вызовите следующую команду из той же папки, где расположен **manage.py**. Вас попросят ввести имя пользователя, адрес электронной почты и надёжный пароль.
```md
python3 manage.py createsuperuser
```
Для входа в админ-панель откройте ссылку /admin (например http://127.0.0.1:8000/admin) и введите логин и пароль вашего нового суперпользователя (вас перенаправят на login-страницу и потом обратно на /admin после ввода всех деталей).
[[подробнее]](https://developer.mozilla.org/ru/docs/Learn/Server-side/Django/Admin_site)
###Авторизация API пользователей.
После регистрации пользователей вам и каждомму из зарегистрированных пользователей будут дступны два эндпоинта для создания токенов авторизации.
| Эндпоинт | Описание |
|-----------------------------------------------|---------------------------|
| http://127.0.0.1:8000/api/v1/jwt/create/ | Получение JWT-токена |
| http://127.0.0.1:8000/api/v1/jwt/refresh/ | Обновление JWT-токена. |
| http://127.0.0.1:8000/api/v1/jwt/verify/ | Проверка JWT-токена |
Для получения токена отправьте POST запрос с данными в формате JSON следующего вида.
```json
{
"username": "string",
"password": "string"
}
```
В ответ придет json ответ:
```json
{
"refresh": "string",
"access": "string"
}
```
Для доступа к апи используйте токен из поля `access`, тип авторизации при запросах: Bearer Token.
Данные эндпоинты доступны без авторизации, остальные энпоинты доступны в большинстве своем, только авторизированным пользователям. Полный перечень эндпоинтов, их подробное описание представлено в [документации к API](#документация-по-API)
### Документация по API
Когда вы запустите проект, по адресу http://127.0.0.1:8000/redoc/ будет доступна документация для **API Yatube**.
Документация представлена в формате [Redoc](https://github.com/Redocly/redoc).
### Поиск в базе данных
По умолчанию к проекту подключена база данны sqlite
и встроенный бэкенд `SearchFilter`. Встроенные фильтрующие бэкенды импортируются из библиотеки `filters`.
[[подробнее]](https://www.django-rest-framework.org/api-guide/filtering/#searchfilter)
Это накладывает определенные ограничения.
- поиск можно вести только по текстовым полям
- при использовании базы данных sqlite поиск нечувствителен к регистру только при запросах на латинице
Можно искать по нескольким совпадениям: в запросе их надо разделить запятыми, без пробелов.
Например, при запросе http://127.0.0.1:8000/posts/?search=Сн,ок в выдачу попадут только те посты, где в тексе есть одновременно все совпадения, например — «Снежок».
Поиск можно производить с использованием [регулярных выражений](https://regex101.com/), что существенно облегчает задачу и повышает гибкость текстового поиска.
### Демонстрационная версия API
Для тестирования API развернута демонстрационная база [проекта Yatube](http://vidim.pythonanywhere.com/).
Необходимо пройти регистрацию на сайте, после чего получить токен, перейти в раздел документации
http://vidim.pythonanywhere.com/redoc и провести тестирование. На сайте доступен интерактивный режим, то есть все запросы к API можно выполнить к демонстрационной демо базе прямо из документации.
P.S. На данный момент времени 18 Мая 2022 года, доступна только основная демонстарционная база, API проекта подключится не позднее 30 Мая 2022 года. Приносим свои извинения.
### Об авторе
Вадим Барсуков,
студент 33 когорты,
Яндекс Практикум
:e-mail: v.bars@vidim.ru
### Контрольная сумма репозитария
`SHA-1: ab09e0fb0ed739ce2a5d5c28eb49db1b2834dbcf`
___
© 2022, Vidim, Inc., temet nosce ツ