https://github.com/always-open/laravel-graphql-schema-generator
Generate a GraphQL schema from your existing Laravel models and database
https://github.com/always-open/laravel-graphql-schema-generator
Last synced: 12 months ago
JSON representation
Generate a GraphQL schema from your existing Laravel models and database
- Host: GitHub
- URL: https://github.com/always-open/laravel-graphql-schema-generator
- Owner: always-open
- License: mit
- Created: 2022-08-03T16:32:57.000Z (almost 4 years ago)
- Default Branch: 1.x
- Last Pushed: 2023-07-18T17:07:49.000Z (about 3 years ago)
- Last Synced: 2024-11-24T19:20:39.543Z (over 1 year ago)
- Language: PHP
- Homepage:
- Size: 37.1 KB
- Stars: 2
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
[
](https://supportukrainenow.org)
# Generate GraphQL schema from existing Laravel models/database
[](https://packagist.org/packages/always-open/laravel-graphql-schema-generator)
[](https://github.com/always-open/laravel-graphql-schema-generator/actions?query=workflow%3Arun-tests+branch%3Amain)
[](https://github.com/always-open/laravel-graphql-schema-generator/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
[](https://packagist.org/packages/always-open/laravel-graphql-schema-generator)
This package will generate a GraphQL schema from your existing Laravel models and database. It reads through the
existing models, relationships, and database to generate a GraphQL schema and optionally queries for each model. You can
also specify additional models such as vendor/packages models to be included.
## Installation
You can install the package via composer:
```bash
composer require always-open/laravel-graphql-schema-generator
```
You can publish the config file with:
```bash
php artisan vendor:publish --tag="laravel-graphql-schema-generator-config"
```
This is the contents of the published config file:
```php
return [
'custom_type_mappings' => [
'timestamp' => 'DateTime',
'datetime' => 'DateTime',
'date' => 'Date',
],
'custom_scalar_definitions' => [
'scalar Date @scalar(class: "Nuwave\\Lighthouse\\Schema\\Types\\Scalars\\Date")',
'scalar DateTime @scalar(class: "Nuwave\\Lighthouse\\Schema\\Types\\Scalars\\DateTime")',
],
'model_path' => app_path('Models'),
'model_stub' => __DIR__ . '/../stubs/graphql_schema.stub',
'schema_path' => app_path('../graphql'),
];
```
## Usage
### Basic/default usage
This command will output the GraphQL schema to the `schema_path` specified in the config file. It will only generate the
schema file and will only parse the models in the `model_path` specified in the config file.
```bash
php artisan laravel-graphql-generator:create-schema
```
### Outputting queries
To also add queries to the schema, pass the `--include-queries` flag. This will generate a GraphQL schema file and query
files for each model in the `model_path` specified in the config file.
```bash
php artisan laravel-graphql-generator:create-schema --include-queries
```
### Adding additional models
If there are additional models that exist outside of the `model_path` that you want to include, you can pass the
`--additional-models` flag. This is very useful if you have vendor/package models that you want to include.
```bash
php artisan laravel-graphql-generator:create-schema --additional-models="\\Spatie\\Tags\\Tag"
```
You can also pass in a comma separated list of models to include.
```bash
php artisan laravel-graphql-generator:create-schema --additional-models="\\Spatie\\Tags\\Tag","\\Spatie\\Activitylog\\Models\\Activity"
```
### Adding additional query properties
The default queries will be created using primary keys and unique indices. If you want to add additional properties to
search you can pass them in using the `--additional-query-properties` flag. It will be applied to every model that has
the specified property.
This command could add queries using the properties `key` and `name`. Support for multiple fields isn't supported by the
pass in as of this version.
```bash
php artisan laravel-graphql-generator:create-schema --additional-query-properties=key,name
```
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](https://github.com/qschmick/.github/blob/main/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [quentin.schmick](https://github.com/qschmick)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.