Giter Club home page Giter Club logo

symfony-api-challenge's Introduction

Symfony API Coding Challenge

by Lucas Rothamel [email protected]

Design:

  • symfony 4.1 using MySQL, Doctrine and FOSRestBundle
  • not using /api prefix, as complete project only includes this api
  • using DataFixtures to provide test data
  • using Codeception api test suite for testing

Setup:

  • checkout the devilbox repos from [http://devilbox.org/]
  • checkout this repository, and place it by simlink into the data/www repository
  • add an entry to /etc/hosts 127.0.0.1 symfony-api-challenge.loc unless using devilboy dns
  • Run by docker-compose up in devilbox directory
  • Open the php docker shell by running shell.sh from the devilbox direcory
  • copy .env.dist to .env, and making adjustments as necessary
  • run setup_mysql_in_devilbox.sh to setup the database
  • run composer install to install all dependencies
  • run the reset_db.sh to reset the database (by dropping), and run all fixtures on the empty database

Documentation:

  • Uses NelmioApiDocBundle and Swagger annotations
  • Auto-generated documentation then available at https://symfony-api-challenge.loc/doc

Tests:

  • Tests can be found in the tests\api folder
  • can be run from the php docker shell using vendor/bin/codecept run

Todo / Known problems:

  • codecept gives one deprecated error of Doctrine\Comon\ClassLoader
  • Swagger documentation should be fine-tuned and extended further
  • User and session Management are completely missing, once added, in JobController::postAction(), the user id of the logged in user should be used instead of the static user id 1

symfony-api-challenge's People

Contributors

dependabot[bot] avatar lucasrothamel 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.