Template

RPC 2.0 API MICROSERVICE BASED ON IJSON

MENU

• ENVIRONMENTS
• ENVIRONMENTS WITHOUT CONTROL PANEL
• RUN WITH CODE
• RUN WITH DOCKER
• DOCUMENTATION

---

ENVIRONMENTS:

• IJSON_HOST - Invert json host and port (with protocol). Default: http://localhost:8001
• PROJECT_ALIAS - panel, apple, etc..
• APP_ENV - dev, prod.
• PANEL_ALIAS - Alias for control-panel. Default: panel

ENVIRONMENTS without control-panel:

• CONTROL_PANEL_DISABLE - Disable control panel microservice config obtain. Default: no
• AUTHORIZATION_DISABLE - Disable authorization microservice import rules. Default: yes
• DATABASE_SEEDER_DISABLE - Disable auto seeding data. Default: no
• MYSQL_HOST - Mysql host.
• MYSQL_PORT - Mysql port.
• MYSQL_DATABASE - Mysql database.
• MYSQL_USER - Mysql user.
• MYSQL_PASSWORD - Mysql password.

RUN WITH DOCKER:

RUN WITH CODE:

• Get code:

  • Modify microservice config see config/app.php or put environments in .env

  • Run docker container ijson and mysql in docker-compose.yml

      docker-compose run mysql
      docker-compose run ijson

    or

      docker-compose up

  • Install dependencies composer install

  • Create configuration:

        ./bin/console microservice:configure

    or for manual configuration add the manual key

        ./bin/console microservice:configure manual

  • Create database php artisan migrations:db

  • Run microservice php artisan microservice:start

  • See scratches folder for make requests

DOCUMENTATION:

• Generate docs composer run-script docs
• Open apidoc-generated/index.html in root dir