README.md

Template

RPC 2.0 API MICROSERVICE BASED ON IJSON

MENU

• ENVIRONMENTS
• RUN WITH CODE
• DOCUMENTATION

---

ENVIRONMENTS:

• IJSON_HOST - Invert json host and port (with protocol). Default: http://localhost:8001
• PROJECT_ALIAS - panel, apple, etc..
• APP_ENV - dev, prod.
• CONTROL_PANEL_DISABLE - Disable control panel microservice config obtain. Default: no
• AUTHORIZATION_DISABLE - Disable authorization microservice import rules. Default: yes
• MYSQL_HOST - Mysql host.
• MYSQL_PORT - Mysql port.
• MYSQL_DATABASE - Mysql database.
• MYSQL_USER - Mysql user.
• MYSQL_PASSWORD - Mysql password.

RUN WITH CODE:

• Get code:

  • git clone https://github.com/kakadu-dev/symfony-microservice-template.git

  • Change microservice name config/services.yaml microservice.service_name:template

  • 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 manual

  • See .env your environments variables

  • Run microservice php bin/console microservice:start

  • See scratches folder for make requests

DOCUMENTATION:

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