CRUD (сокр. от англ. create, read, update, delete — «создать, прочесть, обновить, удалить») — акроним, обозначающий четыре базовые функции, используемые при работе с персистентными хранилищами данных:
- создание;
- чтение;
- редактирование;
- удаление.
Для взаимодействия с ресурсами опишите и настройте такие эндпоинты:
- api/v1/api-token-auth/ (POST): передаём логин и пароль, получаем токен.
- api/v1/posts/ (GET, POST): получаем список всех постов или создаём новый пост.
- api/v1/posts/{post_id}/ (GET, PUT, PATCH, DELETE): получаем, редактируем или удаляем пост по id.
- api/v1/groups/ (GET): получаем список всех групп.
- api/v1/groups/{group_id}/ (GET): получаем информацию о группе по id.
- api/v1/posts/{post_id}/comments/ (GET, POST): получаем список всех комментариев поста с id=post_id или создаём новый, указав id поста, который хотим прокомментировать.
- api/v1/posts/{post_id}/comments/{comment_id}/ (GET, PUT, PATCH, DELETE): получаем, редактируем или удаляем комментарий по id у поста с id=post_id.
Клонируем проект:
git clone https://github.com/themasterid/api_yatube.gitили
git clone [email protected]:themasterid/api_yatube.gitПереходим в папку с проектом:
cd api_yatubeУстанавливаем виртуальное окружение:
python -m venv venvАктивируем виртуальное окружение:
source venv/Scripts/activateДля деактивации виртуального окружения выполним (после работы):
deactivate
Устанавливаем зависимости:
python -m pip install --upgrade pippip install -r requirements.txtПрименяем миграции:
python yatube_api/manage.py makemigrationspython yatube_api/manage.py migrateСоздаем супер пользователя:
python yatube_api/manage.py createsuperuserПри желании делаем коллекцию статики:
python yatube_api/manage.py collectstaticПредварительно сняв комментарий с:
STATIC_ROOT = os.path.join(BASE_DIR, 'static')И закомментировав:
STATICFILES_DIRS = [os.path.join(BASE_DIR, 'static')]Иначе получим ошибку: You're using the staticfiles app without having set the STATIC_ROOT setting to a filesystem path.
В папку с проектом, где файл settings.py добавляем файл .env куда прописываем наши параметры:
SECRET_KEY='Ваш секретный ключ'
ALLOWED_HOSTS='127.0.0.1, localhost'
DEBUG=TrueНе забываем добавить в .gitingore файлы:
.env
.venvДля запуска тестов выполним:
pytestПолучим:
pytest
======================================= test session starts =======================================
platform win32 -- Python 3.10.5, pytest-6.2.4, py-1.11.0, pluggy-0.13.1 -- ...\api_yatube\venv\Scripts\python.exe
django: settings: yatube_api.settings (from ini)
rootdir: ...\api_yatube, configfile: pytest.ini, testpaths: tests/
plugins: django-4.4.0, pythonpath-0.7.3
collected 26 items
tests/test_auth.py::TestAuthAPI::test_auth PASSED [ 3%]
tests/test_comment.py::TestPostAPI::test_comments_not_found PASSED [ 7%]
tests/test_comment.py::TestPostAPI::test_comments_get_unauth PASSED [ 11%]
tests/test_comment.py::TestPostAPI::test_comments_get PASSED [ 15%]
tests/test_comment.py::TestPostAPI::test_comments_create PASSED [ 19%]
tests/test_comment.py::TestPostAPI::test_post_unauth_get_current PASSED [ 23%]
tests/test_comment.py::TestPostAPI::test_post_get_current PASSED [ 26%]
tests/test_comment.py::TestPostAPI::test_post_patch_current PASSED [ 30%]
tests/test_comment.py::TestPostAPI::test_post_unauth_patch_current PASSED [ 34%]
tests/test_comment.py::TestPostAPI::test_post_delete_current PASSED [ 38%]
tests/test_comment.py::TestPostAPI::test_post_unauth_delete_current PASSED [ 42%]
tests/test_group.py::TestGroupAPI::test_group_not_found PASSED [ 46%]
tests/test_group.py::TestGroupAPI::test_group_not_auth PASSED [ 50%]
tests/test_group.py::TestGroupAPI::test_group_auth_get PASSED [ 53%]
tests/test_group.py::TestGroupAPI::test_group_create PASSED [ 57%]
tests/test_group.py::TestGroupAPI::test_group_get_post PASSED [ 61%]
tests/test_post.py::TestPostAPI::test_post_not_found PASSED [ 65%]
tests/test_post.py::TestPostAPI::test_post_not_auth PASSED [ 69%]
tests/test_post.py::TestPostAPI::test_posts_auth_get PASSED [ 73%]
tests/test_post.py::TestPostAPI::test_post_auth_create PASSED [ 76%]
tests/test_post.py::TestPostAPI::test_post_unauth_create PASSED [ 80%]
tests/test_post.py::TestPostAPI::test_post_get_current PASSED [ 84%]
tests/test_post.py::TestPostAPI::test_post_patch_current PASSED [ 88%]
tests/test_post.py::TestPostAPI::test_post_auth_delete_current PASSED [ 92%]
tests/test_post.py::TestPostAPI::test_post_unauth_delete_current PASSED [ 96%]
tests/test_auth.py::TestAuthAPI::test_settings PASSED [100%]
======================================== warnings summary =========================================Запускаем проект:
python yatube_api/manage.py runserver localhost:80После чего проект будет доступен по адресу http://localhost/
Заходим в http://localhost/admin и создаем посты, группы, комментарии. Тестировать и добавлять данные удобно посkе прохождения авторизации через Postman.
Автор: Дмитрий Клепиков 👍