Необходимо написать простейшее REST API для каталога товаров.
Приложение должно содержать:
- Категории товаров
- Конкретные товары, которые принадлежат к какой-то категории (один товар может принадлежать нескольким категориям)
- Пользователей, которые могут авторизоваться
Возможные действия:
- Получение списка всех категорий
- Получение списка товаров в конкретной категории
- Авторизация пользователей
- Добавление/Редактирование/Удаление категории (для авторизованных пользователей)
- Добавление/Редактирование/Удаление товара (для авторизованных пользователей)
- PHP, HTML;
- Возможно использование готовых классов и библиотек;
- Framework – предпочтительно Yii2 или без framework’ов;
- Можно использовать composer;
- Должны быть unit тесты;
- В проекте должны быть тесты, которые проверяют REST API (behat или codeception);
- Проект должен проходить проверку https://github.com/squizlabs/PHP_CodeSniffer со стилем PSR2;
- Проект должен проходить проверку https://github.com/phpstan/phpstan;
- По REST API должна быть документация в формате https://swagger.io/;
- Комментарии в коде – приветствуются.
- Ссылка на код на Github / BitBucket;
- Как плюс, ссылка на работающий пример.
По каждому критерию можно получить только фиксированный балл, внутри одного критерия баллы не суммируются.
| Описание | Балл |
|---|---|
| нет никаких инструкций | 0 |
| есть README.md | 0.5 |
| использован vagrant | 0.75 |
| использован docker | 1 |
| есть docker-compose.yml | 1.5 |
| Описание | Балл |
|---|---|
| нет | -1 |
| соблюден какой-либо codestyle | 0.5 |
| PSR2 | 1 |
phpcs --standard=PSR2 не выдает ошибок |
1.75 |
| корректно настроен phpcs.xml.dist | 2 |
| Описание | Балл |
|---|---|
| не исправлены ошибки phpstan level=0 | 0 |
| исправлены ошибки phpstan level=0 | 1 |
настроен phpstan.neon. vendor/bin/phpstan analyse -l 0 -c phpstan.neon <directories> не показывает ошибок, где <directories> - папки с бизнес логикой, исправлять ошибки в vendor, либо в системных файлах фреймфорка не надо |
1.5 |
| Описание | Балл |
|---|---|
| в проекте нет composer.json | 0 |
| в проекте есть composer.json, но некоторые библиотеки подключены не через него | 0.5 |
| все сторонние библиотеки подключены через composer.json | 1 |
| Описание | Балл |
|---|---|
| отсутствует | -0.5 |
| присутствует, есть замечания | 0.5 |
| присутствует, нет замечаний | 1 |
| Описание | Балл |
|---|---|
| отсутствует | 0 |
| присутствует, есть замечания | 0.5 |
| присутствует, нет замечаний | 1 |
| Описание | Балл |
|---|---|
| отсутствует | -0.5 |
| присутствует, есть замечания | 0.5 |
| присутствует, нет замечаний | 1 |
| Описание | Балл |
|---|---|
| нарушен | -0.5 |
| есть замечания | 0.5 |
| нет замечаний | 1 |
[опционально] При желании можно прогнать проект через phpcpd (https://github.com/sebastianbergmann/phpcpd).
| Описание | Балл |
|---|---|
| нарушен | 0 |
| есть замечания | 0.5 |
| нет замечаний | 1 |
| Описание | Балл |
|---|---|
| используются global переменные в явном виде | -1 |
| есть неявное использование | 0 |
| никак не используются | 1 |
| Описание | Балл |
|---|---|
| есть замечания | 0 |
| нет замечений | 2 |
Способ проверки: написать чистый unit тест на класс/метод/функцию, внутри которой будет использоваться static метод/свойство.
Wikipedia: Магическое число (программирование)
| Описание | Балл |
|---|---|
| есть замечания | -1 |
| нет замечений | 1 |
| Описание | Балл |
|---|---|
| бизнес логика написана в классе ActiveRecord | 0 |
| бизнес логика вынесена из классов ActiveRecord | 2 |
| Описание | Балл |
|---|---|
| толстый контроллер | 0 |
| тонкий контроллер | 2 |
| Описание | Балл |
|---|---|
| отсутствует | 0 |
| присутствует, есть замечания | 2 |
| присутствует, нет замечаний | 4 |
| Описание | Балл |
|---|---|
| отсутствуют | 0 |
| присутствуют | 1 |
| есть на все endpoints | 2 |
100% code coverage (vendor/bin/codecept run --coverage --coverage-xml --coverage-html) |
2 |
| Описание | Балл |
|---|---|
| отсутствуют | -0.5 |
| написаны на codeception unit | 1 |
| написаны на phpunit, есть phpunit.xml.dist | 1.5 |
| использован Mockery | 2 |
| тесты на самом деле unit, codecoverage > 50% | 3 |
- https://docs.docker.com/get-started/
- https://docs.docker.com/compose/
- https://www.php-fig.org/psr/
- https://github.com/squizlabs/PHP_CodeSniffer/wiki
- https://github.com/phpstan/phpstan
- https://getcomposer.org/doc/00-intro.md
- https://swagger.io/docs/
- https://codeception.com/quickstart
- https://github.com/sebastianbergmann/phpcpd
- https://phpunit.de/documentation.html
- https://github.com/mockery/mockery
- https://refactoring.guru/ru
- Стив Макконнелл. Совершенный код.
- https://ru.wikipedia.org/wiki/Design_Patterns
- http://wiki.c2.com/?GlobalVariablesAreBad