prestashop/ps_apiresources

PrestaShop - API Resources

dev-dev 2025-04-24 08:34 UTC

Requires

• php: >=8.1

Requires (Dev)

• czproject/git-php: ^4.2
• friendsofphp/php-cs-fixer: ^v3
• phpunit/phpunit: ^10
• prestashop/php-dev-tools: ^4.3

AFL-3.0

• PrestaShop SA

README

About

Includes the resources allowing using the API for the PrestaShop domain, all endpoints are based on CQRS commands/queries from the Core and we APIPlatform framework is used as a base.

This module contains no code only some resource files that are automatically scanned and integrated by the Core, these resources are in this folder.

Reporting issues

You can report issues with this module in the main PrestaShop repository. Click here to report an issue.

Requirements

Required only for development:

• composer

Installation

Install all dependencies.

composer install

Run tests locally

Initialize tmp shop environment

First initialize the test environment with this command that will install a PrestaShop shop in a temporary folder so that the integration tests can run:

composer create-test-db

Customize tmp shop environment

You can define custom values when setting up the tmp shop:

composer clear-test-cache
composer setup-local-tests -- [arguments]
  arguments:
    --force-clone Force cloning the repository even if cloned repository is detected (when no repository is detected the clone is automatic)
    --build-assets Force building assets even if they are already built (when no assets are detected the build is automatic)
    --build-db Force building DB by installing the default shop data (when no DB is detected the DB shop is installed automatically)
    --update-local-parameters Force copying parameters from the `test/local-parameters` folder (when no parameter file is detectec they are automatically copied)
    --force Force all the previous arguments
    --core-branch Use a specific branch, you can use a branch from the original repository (ex: `develop`, `9.0.x`, ...) or from a fork (ex: `myfork:my-dev-branch`) (By default branch develop is used)

Example:

composer setup-local-tests -- --force --core-branch=jolelievre:product-api

Run tests

Then you can run the tests with this command:

composer run-module-tests

Contributing

PrestaShop modules are open source extensions to the PrestaShop e-commerce platform. Everyone is welcome and even encouraged to contribute with their own improvements!

Just make sure to follow our contribution guidelines.

License

This module is released under the Academic Free License 3.0