Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oxid-esales/graphql-configuration-access
OXAPI (GraphQL based) access to configuration settings
https://github.com/oxid-esales/graphql-configuration-access
Last synced: about 1 month ago
JSON representation
OXAPI (GraphQL based) access to configuration settings
- Host: GitHub
- URL: https://github.com/oxid-esales/graphql-configuration-access
- Owner: OXID-eSales
- License: other
- Created: 2023-08-31T08:26:54.000Z (over 1 year ago)
- Default Branch: b-7.2.x
- Last Pushed: 2024-11-06T12:13:19.000Z (about 2 months ago)
- Last Synced: 2024-11-06T13:21:27.063Z (about 2 months ago)
- Language: PHP
- Size: 824 KB
- Stars: 14
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/OXID-eSales/graphql-configuration-access/actions/workflows/trigger.yml)
[](https://packagist.org/packages/oxid-esales/graphql-configuration-access)
[](https://github.com/oxid-esales/graphql-configuration-access)
[](https://sonarcloud.io/dashboard?id=OXID-eSales_graphql-configuration-access)
[](https://sonarcloud.io/dashboard?id=OXID-eSales_graphql-configuration-access)
[](https://sonarcloud.io/dashboard?id=OXID-eSales_graphql-configuration-access)
# graphql-configuration-access
OXAPI (GraphQL based) access to configuration settings
### Why we use this schema
To fetch and update the configurations we implemented a different query/mutation per value-type.
We have chosen this schema because of GraphQL's strictness which doesn't allow for dynamic types. Without these types,
the API consumer would always have to convert the value after queries or before mutations if, for example,
we decided to use json encoded strings instead.
To get the specific type of a configuration, we provide queries like
`shopSettings`/`moduleSettings`/`themeSettings` to figure out the type for configurations.
As a result you get an array of setting types:
```
type SettingType {
name: string!
type: FieldType!
isSupported: boolean!
}
enum FieldType {
'str'
'select'
'bool'
'num
'arr'
'aarr'
}
```
## Documentation
* Full documentation can be found [here](https://docs.oxid-esales.com/interfaces/graphql/en/latest/).
### Install
Switch to the shop root directory (the file `composer.json` and the directories `source/` and `vendor/` are located there).
```bash
# Install desired version of oxid-esales/graphql-configuration-access module, in this case - latest released 1.x version
$ composer require oxid-esales/graphql-configuration-access ^1.0.0
```
If you didn't have the `oxid-esales/graphql-base` module installed, composer will do that for you.
After installing the module, you need to activate it, either via OXID eShop admin or CLI.
```bash
$ vendor/bin/oe-console oe:module:activate oe_graphql_base
$ vendor/bin/oe-console oe:module:activate oe_graphql_configuration_access
```
### How to use
A good starting point is to check the [How to use section in the GraphQL Base Module](https://github.com/OXID-eSales/graphql-base-module/#how-to-use)
## Blocking modules from de/activation via GraphQL
The file module_blockilst.yaml contains a list of modules which are necessary to handle configurations or de/activate
modules via GraphQL or should be blocked for de/activation via GraphQL in general. Modules like ``oe_graphql_base`` and
``oe_graphql_configuration_access`` are listed there.
## Testing
### Linting, syntax check, static analysis
```bash
$ composer update
$ composer static
```
### Unit/Integration/Acceptance tests
- install this module into a running OXID eShop
- reset shop's database
```bash
$ 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
```bash
$ composer phpunit
```
- run Unit tests
```bash
$ ./vendor/bin/phpunit -c vendor/oxid-esales/graphql-configuration-access/tests/phpunit.xml
```
- run Integration tests
```bash
$ ./vendor/bin/phpunit --bootstrap=./source/bootstrap.php -c vendor/oxid-esales/graphql-configuration-access/tests/phpintegration.xml
```
- run Acceptance tests
```bash
$ composer codeception
```