Giter Club home page Giter Club logo

cms-simplified's Introduction

Assignment

Headless (no UI) CMS for managing articles (CRUD). Each article has its ID, title, body and timestamps (on creation and update). Managing articles is the typical set of CRUD calls including reading one and all the articles. Creating/updating/deleting data is possible only if a secret token is provided (can be just one static token).
For reading all the articles, the endpoint must allow specifyinga field to sort by including whether in an ascending or descending order + basic limit/offset pagination. The whole client-server communication must be in a JSON format. The architecture must follow Domain-Driven Design

Solution

  • Symfony 4.4 LTS
  • FOS Rest, Doctrine, phpunit, swagger
  • Some database (tested on PgSQL)

Installation

  • composer install
  • set up your database in .env.(test|dev).local
  • set up your APP_TOKEN in .env.(test|dev).local
  • bin/console doctrine:migrations:migrate
  • bin/phpunit

Methods

GET /api/article/list?sort=title&direction=desc&limit=11&offset=0
POST /api/article/create
{"title": "title", "body": "body"}
POST /api/article/update/{id}
{"title": "title", "body": "body"}
POST /api/article/delete/{id}

Swagger

N.B.

  • I know about RESTfull, but I'm not a big fan of this
  • very simple diagram
  • need more time: tests for sorting, different cases
  • need more time: xml format via View and ViewHandler
  • it's strange, but .env.local doesn't work
  • ParameterBug doesn't work too

cms-simplified's People

Contributors

ploginoff 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.