Giter Club home page Giter Club logo

todolist's Introduction

Оглавление

Постановка задачи

Написать RESTful ToDoList API без использования фрейморков

Функционал

  • Взаимодействие с логикой API с помощью http запросов

  • Хранение в таблице параметров задачи, которую нужно выполнить

  • Структура таблицы:

    name id body status
    varchar(255) varchar(255) varchar(255) varchar(255)
  • CRUD методы для контроля операций над содержимым таблицы

  • Валидация входных параметров

  • Возврат Response Body в формате json

  • Возврат параметра Response Head status в зависимости от ситуации

Компоненты

  • Технологии
    • php 7.2
    • PostgreSQL 10.9
    • Composer
    • Git
  • Использованные библиотеки
    • Ramsey/Uuid - генерация id в формате Uuid
    • Zend/Diactors - представление request и response в виде объектов
    • Aura/Routing - http mapping
  • Утилиты
    • GNU Make 4.2.1

Инструкция

  1. Изменить конфигурацию файла db_configExample.ini
    • /path/to/project/src/Connect/db_config.Example.ini
    • Изменить название (db_configExample.ini -> db_config.ini)
    • Изменить его внутренние параметры в соответствии с используемой б\д
  2. Создать таблицу для хранения задач при помощи ввода команды утилиты make
    $ make create-table
    
  3. Запустить встроенный в php веб-сервер командой make
    $ make start
    
  4. Перейти по одному из существующих роутов:
Функция URL Метод Параметры
Вернуть конкретную задачу HOST:8000/tasks/{id} GET id - идентификатор задачи
Вернуть весь список задач HOST:8000/tasks GET -
Добавить задачу HOST:8000/tasks POST name - название задачи; body - описание задачи
Изменить содержимое задачи HOST:8000/tasks/{id}/body PUT id - идентификатор задачи; body - описание задачи
Изменить статус задачи HOST:8000/tasks{id}/status PUT id - идентификатор задачи; status - статус задачи
Удалить задачу HOST:8000/tasks/{id} DELETE id - идентификатор задачи

Выводы

В ходе написания моего первого проекта я узнал о следующих вещах:

  • Написание кода и его оформление
    • Data Hiding
    • Type Hinting
  • Парадигмы и паттерны программирования и проектирования
    • Named Constructors
    • Data Transfer Object
    • Dependency Injection
    • OOP
    • MVC
    • SOLID
    • GRASP
    • REST
    • LIFT
    • CRUD

todolist's People

Contributors

velenium avatar

Stargazers

Mauro Bonfietti avatar  avatar

Watchers

 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.