experteam/api-base-bundle

Base functionality bundle for APIs

3.5.2 2024-11-18 16:04 UTC

Requires

• php: >=8.1
• ext-bcmath: *
• ext-json: *
• ext-pdo: *
• ext-redis: *
• doctrine/doctrine-bundle: ^2.8
• doctrine/doctrine-fixtures-bundle: ^3.4
• doctrine/orm: ^2.14
• friendsofsymfony/rest-bundle: ^3.5
• nelmio/api-doc-bundle: ^4.0
• php-di/phpdoc-reader: ^2.2
• symfony/config: 6.3.*|6.4.*
• symfony/dependency-injection: 6.3.*|6.4.*
• symfony/http-client: 6.3.*|6.4.*
• symfony/http-kernel: 6.3.*|6.4.*
• symfony/security-bundle: 6.3.*|6.4.*
• symfony/security-core: 6.3.*|6.4.*
• symfony/serializer: 6.3.*|6.4.*
• symfony/uid: 6.3.*|6.4.*
• symfony/validator: 6.3.*|6.4.*

Requires (Dev)

• symfony/dotenv: 6.3.*|6.4.*
• symfony/flex: ^2
• symfony/framework-bundle: 6.3.*|6.4.*
• symfony/phpunit-bridge: 6.3.*|6.4.*

MIT

• Experteam

README

Base Services for APIs in Symfony 5.1+
It includes:

• Params Client: Service to obtain the value of parameters defined in api-companies.
• JSend Response: Sets the format of the JSON response according to the JSEND specification (https://github.com/omniti-labs/jsend).
• Request Util: Request validation service.

Install

1. Run de following composer command:
   

composer require experteam/api-base-bundle

1. Create the configuration file through any of the following options:
   
   

   a. Manually copy the example file in the package root to the folder config/packages/.
   
   b. Copy the vendor_copy.php file to the root of the project and configure the scripts in the composer.json file:

   "scripts": {
        "vendor-scripts": [
            "@php vendor_copy.php -s vendor/experteam/api-base-bundle/experteam_api_base.yaml.example -d config/packages/experteam_api_base.yaml --not-overwrite --ignore-no-source"
        ],
        "post-install-cmd": [
            "@vendor-scripts"
        ],
        "post-update-cmd": [
            "@vendor-scripts"
        ]
    },
   

2. Edit the bundle configuration file config/packages/experteam_api_base.yaml:
   

experteam_api_base:
    params:
        remote:
            enabled: [Enabled]
            url: [URL]
        defaults:
            [PARAM NAME]: [Value]
            [PARAM NAME]: [Value]

Update

Run de following composer command:

composer update experteam/api-base-bundle

License

MIT license.