Download the PHP package oxid-esales/graphql-base without Composer

On this page you can find all versions of the php package oxid-esales/graphql-base. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package graphql-base

oxid-esales/graphql-base

Build Status Build Status

Stable Version Latest Version PHP Version

This module provides:

Documentation

Usage

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

Branch Compatibility

Install

You should run migrations both after installing the module and after each module update:

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

Update

If you when to update this module from older version to new version. Then run below command to ensure that all dependencies including in the composer.lock are updated that are compatible with each other.

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

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.

You should see a response similar to this:

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

How to use refresh tokens

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

The response should contain both requested tokens:

The request will set an HttpOnly cookie with unique fingerprint. The accessToken claims contain a hashed version of this fingerprint. The access token should be sent as Bearer type authorization as described above. After the access token's lifetime has elapsed, you will need to refresh it. To do this you will need to send the following query:

If the token is valid and the hash matches the fingerprint sent as cookie, you will receive a fresh token as a response:

And along with it, a new fingerprint cookie and fingerprintHash claim in the jwt token.

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

Unit/Integration/Acceptance tests

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

OXID Module and Component License, see LICENSE file.

All versions of graphql-base with dependencies

PHP Build Version
Package Version
Requires php Version ^8.2
ext-json Version *
thecodingmachine/graphqlite Version ^6.2
lcobucci/jwt Version ^4.1
symfony/cache Version *
ecodev/graphql-upload Version ^7.0.0
laminas/laminas-diactoros Version ^2.5
myclabs/php-enum Version ^1.8
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package oxid-esales/graphql-base contains the following files

Loading the files please wait ....