oxid-esales/graphql-base

OXID eSales GraphQL base module

Installs: 44 609

Dependents: 8

Suggesters: 1

Security: 0

Stars: 15

Watchers: 9

Forks: 15

Type:oxideshop-module

v7.0.2 2022-08-10 09:46 UTC

README

Build Status Build Status

Stable Version Latest Version PHP Version

This module provides:

  • a basic GraphQL implementation for the OXID eShop
  • authorization and authentication using JWT
  • a query to log you in and get a JWT for further authentication

Documentation

  • Full documentation can be found here.
  • Schema documentation available here.

Usage

This assumes you have OXID eShop (at least OXID-eSales/oxideshop_ce: v7.0.0 component, which is part of the 7.0.0 compilation) up and running.

Branch Compatibility

  • master branch is compatible with latest shop compilation: 7.0.x
  • 7.x versions (or b-6.5.x branch) are compatible with latest shop compilations: 6.5.x resp. b-6.5.x shop compilation branches
  • 6.x versions (or b-6.4.x branch) are compatible with latest shop compilations: 6.4.x resp. b-6.4.x shop compilation branches
  • 5.x versions (or b-6.3.x branch) are compatible with latest shop compilations: 6.3.x resp. b-6.3.x shop compilation branches (NOTE: no support for PHP 8 yet)

Install

# Install desired version of oxid-esales/graphql-base module, in this case - latest released 7.x version
$ composer require oxid-esales/graphql-base ^7.0.0

After requiring the module, you need to activate it, either via OXID eShop admin or CLI.

$ ./bin/oe-console oe:module:activate oe_graphql_base

How to use

You can use your favourite GraphQL client to explore the API, if you do not already have one installed, you may use Altair GraphQL Client.

To login and retrieve a token send the following GraphQL query to the server

query {
    token (
        username: "admin@admin.com",
        password: "admin"
    )
}

You could simply fire up your terminal and use curl to do a basic check if the GraphQL base module is up and running as expected. To retrieve a valid token you need to replace the username and password below with valid login credentials.

$ curl http://oxideshop.local/graphql/ \
  -H 'Content-Type: application/json' \
  --data-binary '{"query":"query {token(username: \"admin@admin.com\", password: \"admin\")}"}'

You should see a response similar to this:

{
    "data": {
        "token": "a-very-long-jwt"
    }
}

This token is then to be send as your authorization with every request in the HTTP Authorization header like this:

Authorization: Bearer a-very-long-jwt

How to extend

The information on extending any module can be found in the OXID eSales documentation.

How to extend GraphQL module types and implement your new mutations and queries is shown in OXID GraphQL API documentation.

Testing

Syntax check and static analysis

$ composer static

Unit/Integration/Acceptance tests

  • install this module into a running OXID eShop
  • reset shop's database
$ bin/oe-console oe:database:reset --db-host=db-host --db-port=db-port --db-name=db-name --db-user=db-user --db-password=db-password --force
  • run Unit/Integration tests
$ ./vendor/bin/phpunit -c vendor/oxid-esales/graphql-base/tests/phpunit.xml
  • run Acceptance tests
$ SELENIUM_SERVER_HOST=selenium MODULE_IDS=oe_graphql_base vendor/bin/codecept run acceptance -c vendor/oxid-esales/graphql-base/tests/codeception.yml

Issues

To report issues with GraphQL module please use the OXID eShop bugtracking system.

Contributing

You like to contribute? 🙌 AWESOME 🙌
Go and check the contribution guidelines

Build with

License

GPLv3, see LICENSE file.