Code Monkey home page Code Monkey logo

ispring-todo-list-api's Introduction

License GitHub go.mod Go version Coverage Status Go Report Card

Внимание: Тестовое задание найдено на просторах github-а. Для обучения и тренировки, попробовал решить ее в меру своего понимания. На ревью не отправлял, за оптимальность не ручаюсь.

Сервис Todo List

Задача

Создать REST-API сервис, который позволяет вести список задач, и провести с ними простейшие действия.
Подробнее здесь

Решение

git clone https://github.com/p12s/ispring-todo-list-api.git
cd ispring-todo-list-api 

mv configs/config.example.yml configs/config.yml
mv .env.example .env

docker-compose up -d

Что происходит:

  • поднимается контейнер с PostgreSQL
  • поднимается контейнер с сервисом migrate для инициализации/миграции БД
  • БД приводится к рабочему виду, контейнер с migrate удаляется
  • поднимается контейнер с кодом приложения: http://localhost/swagger/index.html

Требования

  • ✅ Язык программирования: PHP 7.x или Go
    Go
  • ✅ СУБД: MySQL или postgresql
    PostgreSQL
  • ✅ Исходный код разместить в репозитории на GitHub
  • ✅ Использование фреймворков и библиотек по желанию
    Gin
  • ❌ Привести сервис в полное соответствие заданию (получение невыполненных задач, 404 при неверном идентификаторе и т.п.)

Дополнительные задания

  • ✅ Метод API, позволяющий получить список архивных задач (которые были помечены выполненными) {{host}}:{{port}}/api/items/completed
  • ✅ набор API тестов, позволяющих проверить работу приложения в автоматическом режиме. Реализовать можно с помощью Postman (https://www.postman.com/use-cases/api-testing-automation/)
    Описание запуска из командной строки
  • ✅ Dockerfile, который содержит все необходимые настройки и зависимости для быстрого разворачивания окружения.
    docker-compose

Добавил от себя

  • swagger - документация
  • бейдж с %-ом покрытия unit-тестами (сейчас 0%)
  • бейдж с результатом запуска тестов и пробной сборки в Github Actions для master-ветки

Что можно улучшить

  • Покрыть код unit-тестами (пока только интеграционные - с помощью postman)
  • Настроить запуск сервиса с помощью docker-compose, чтобы поднимался сервис и БД (сейчас контейнер с postgres поднимаю руками + накатываю миграции)
  • Использовать FastHTTP вместо Gin
  • Добавить индексы в БД
  • Забенчмаркать с помощью wrk для проверки производительности
  • Отпрофилировать с помощью pprof и по-возможности, зарефакторить. А после снова забенчмаркать

ispring-todo-list-api's People

Contributors

p-12s avatar p12s avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

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.