Giter Club home page Giter Club logo

lumen-api's Introduction

Lumen API

This is a implementation of API using Lumen, Doctrine, Migrations, Swagger, and PHPUnit.

Installation

This project use docker-compose.

$ git clone https://github.com/mirandawork/lumen-api.git
$ cd lumen-api
$ docker-compose up --build

Run the commands after all the containers are running.

$ docker-compose exec backend bash
$ cp .env.local .env
$ composer.phar install 
$ php artisan doctrine:migrations:migrate

Usage

Run phpunit inside the backend(php-fpm) container.

$ ./vendor/bin/phpunit

Run migrations after the phpunit because the database is reset.

$ php artisan doctrine:migrations:migrate

The swagger ui is located in http://localhost:3000/api/documentation.

The swagger.json can be view in http://localhost:3000/docs.

The swagger.json is generated by the libraries darkaonline/swagger-lume and zircote/swagger-php. It is located in storage/api-docs/api-docs.json

Improvements

  • Add the migrations to an entry point in Dockerfile.
  • Add more tests.

License

MIT

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.