Giter Club home page Giter Club logo

api_yamdb's Introduction

API YaMDb

CI CI Code style: black mypy isort License

Описание

Проект YaMDb собирает отзывы пользователей на различные произведения.

Технологии

  • Python v3.9
  • Django v3.2
  • Django Rest Framework v3.12

Запуск проекта в dev-режиме

  • Склонируйте репозиторий и перейдите в директорию проекта
git clone https://github.com/mign0n/api_yamdb.git && cd api_yamdb
  • Установите виртуальное окружение, установите зависимости, выполните миграции с помощью команды:
make install
  • Запустите тесты:
make test
  • Запустите сервер:
make run
  • Перейдите по адресу 127.0.0.1:8000/api/v1/doc. Эта страница содержит интерактивную документацию по API.

Примеры запросов

Для регистрации пользователя отправьте POST-запрос по адресу 127.0.0.1:8000/api/v1/auth/signup/:

curl --header "content-type:application/json" \
--data '{"username":"<ИМЯ-ПОЛЬЗОВАТЕЛЯ>","email":"<ВАШ-EMAIL>"}' \
--request POST http://127.0.0.1:8000/api/v1/auth/signup/

Примерный ответ:

{"username":"<ИМЯ-ПОЛЬЗОВАТЕЛЯ>","email":"<ВАШ-EMAIL>"}

На адрес <ВАШ-EMAIL> придет письмо с кодом подтверждения <ВАШ-КОД>. Чтобы получить токен отправьте POST-запрос по адресу 127.0.0.1:8000/api/v1/auth/token/:

curl --header "content-type:application/json" \
--data '{"username":"<ИМЯ-ПОЛЬЗОВАТЕЛЯ>","confirmation_code":"<ВАШ-КОД>"}' \
--request POST http://127.0.0.1:8000/api/v1/auth/token/

Примерный ответ:

{"token":"<ВАШ-ТОКЕН-ДОСТУПА>"}

HTTP-запросы можно отправлять прямо со страницы документации 127.0.0.1:8000/api/v1/doc/. Для авторизации используйте полученный ранее токен.

api_yamdb's People

Contributors

mign0n avatar sorath2 avatar monteg179 avatar

Watchers

 avatar

api_yamdb's Issues

Везде, где мы используем роли - не используем строки, а используем константу

Везде, где мы используем роли - не используем строки, а используем константу

return self.is_superuser or self.role == 'admin'

return self.is_admin or self.role == 'moderator'

return self.is_moderator or self.role == 'user'

Стоит поставить ограничение через срез. 15 символов хватит.

Так как текст может быть очень большим и у нас будет портянка из текста, там где мы будем использовать строковое представление модели. Стоит поставить ограничение через срез. 15 символов хватит.

return self.text

return self.text

Рекомендуется использовать related_name вместо фильтра

Рекомендуется использовать related_name вместо фильтра для улучшения читаемости кода и более простого доступа к связанным объектам. Пример использования можно найти здесь: https://www.rupython.com/related_name-django-2429.html

and Review.objects.filter(

Тут лучше сделать PositiveSmallIntegerField

Тут лучше сделать PositiveSmallIntegerField
Так как мы делаем поиск по году, чтобы его ускорить можно добавить индекс.
https://ru.stackoverflow.com/questions/976248/django-db-index-in-field-%D1%87%D1%82%D0%BE-%D1%8D%D1%82%D0%BE-%D0%B8-%D0%B7%D0%B0%D1%87%D0%B5%D0%BC

year = models.IntegerField(

score = models.IntegerField(

Избегать использования "magic number".

Рекомендуется вынести цифры в константы и избегать использования "magic number".

max_length=150,

max_length=254,

max_length=150,

max_length=254,

max_length=150,

max_length=254,

max_length=150,

max_length=254,

validators=[MinValueValidator(1), MaxValueValidator(10)],

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.