{"id":19662372,"url":"https://github.com/axeldotdev/laravel-graphql-docs","last_synced_at":"2025-07-14T17:07:51.424Z","repository":{"id":116760094,"uuid":"402996041","full_name":"axeldotdev/laravel-graphql-docs","owner":"axeldotdev","description":"Laravel GraphQL Docs is a package that help you create a beautiful doc for you API.","archived":false,"fork":false,"pushed_at":"2021-09-06T15:47:14.000Z","size":45,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-27T03:23:54.222Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/axeldotdev.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"axeldotdev"}},"created_at":"2021-09-04T07:43:13.000Z","updated_at":"2021-10-01T23:14:28.000Z","dependencies_parsed_at":null,"dependency_job_id":"f3223ffb-5a04-4fba-a8e0-c942a401d2c3","html_url":"https://github.com/axeldotdev/laravel-graphql-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/axeldotdev/laravel-graphql-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/axeldotdev%2Flaravel-graphql-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/axeldotdev%2Flaravel-graphql-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/axeldotdev%2Flaravel-graphql-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/axeldotdev%2Flaravel-graphql-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/axeldotdev","download_url":"https://codeload.github.com/axeldotdev/laravel-graphql-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/axeldotdev%2Flaravel-graphql-docs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265322205,"owners_count":23746574,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-11T16:10:53.738Z","updated_at":"2025-07-14T17:07:51.147Z","avatar_url":"https://github.com/axeldotdev.png","language":"PHP","funding_links":["https://github.com/sponsors/axeldotdev"],"categories":[],"sub_categories":[],"readme":"# This is my package laravel-graphql-docs\n\n[![Latest Version on Packagist](https://img.shields.io/packagist/v/axeldotdev/laravel-graphql-docs.svg?style=flat-square)](https://packagist.org/packages/axeldotdev/laravel-graphql-docs)\n[![GitHub Tests Action Status](https://img.shields.io/github/workflow/status/axeldotdev/laravel-graphql-docs/run-tests?label=tests)](https://github.com/axeldotdev/laravel-graphql-docs/actions?query=workflow%3Arun-tests+branch%3Amain)\n[![GitHub Code Style Action Status](https://img.shields.io/github/workflow/status/axeldotdev/laravel-graphql-docs/Check%20\u0026%20fix%20styling?label=code%20style)](https://github.com/axeldotdev/laravel-graphql-docs/actions?query=workflow%3A\"Check+%26+fix+styling\"+branch%3Amain)\n[![Total Downloads](https://img.shields.io/packagist/dt/axeldotdev/laravel-graphql-docs.svg?style=flat-square)](https://packagist.org/packages/axeldotdev/laravel-graphql-docs)\n\nGraphQL Docs is a package that help you create a beautiful documentation for you API.\n\n## Installation\n\nYou can install the package via composer:\n\n```bash\ncomposer require axeldotdev/laravel-graphql-docs\n```\n\nYou can install and publish the needed files with:\n\n```bash\nphp artisan graphql-docs:install\n```\n\nYou can also generate files that will help you write human readable content for you documentation:\n\n```bash\nphp artisan graphql-docs:generate-types-views\n```\n\nThis is the contents of the published config file:\n\n```php\nreturn [\n    /**\n     * GraphQL Docs can be enabled or disabled.\n     *\n     * It is usefull if you don't want to activated it\n     * on a certain environment for example.\n     */\n    'enabled' =\u003e env('GRAPHQL_DOCS_ENABLED', true),\n\n    /**\n     * The title in the meta attributes and\n     * on the home page can be changed.\n     *\n     * When you are in a child page, a suffix will be added\n     * depending on the selected strategy.\n     */\n    'name' =\u003e env('APP_NAME') . ' - GraphQL Docs',\n\n    /**\n     * The GraphQL Docs path can be changed to fit your need.\n     *\n     * By default, no one has access to the documentation.\n     * But you can changed that behaviour within\n     * the published service provider.\n     */\n    'path' =\u003e env('GRAPHQL_DOCS_PATH', 'docs/graphql'),\n\n    /**\n     * GraphQL Docs can be display in many ways with theme.\n     * The default theme is beautiful and simple.\n     *\n     * Go to the package documentation to see\n     * all the supported theme.\n     *\n     * If none of the themes orks for you, don't hesitate to\n     * publish the package views and override it.\n     * Or even better, send a PR and we'll see if your theme\n     * can be implemented.\n     */\n    'theme' =\u003e [\n        /**\n         * The theme name is important, without it,\n         * you will see nothing at all.\n         *\n         * It allow GraphQL Docs to find the right view files.\n         */\n        'name' =\u003e 'default',\n\n        /**\n         * GraphQL Docs also supports dark mode.\n         */\n        'dark_mode' =\u003e [\n            /**\n             * It can be disabled if you don't have a need for it.\n             */\n            'enabled' =\u003e true,\n\n            /**\n             * And you can also specify that it is the default behaviour.\n             *\n             * By default, the dark mode is displayed if the user\n             * operating system is in dark mode, but you can changed that.\n             */\n            'default_on' =\u003e false,\n        ],\n    ],\n\n    /**\n     * To display your API Schema informations,\n     * GraphQL Docs use strategies.\n     *\n     * It means that it follow some rules to parse and\n     * display content of the schema.\n     *\n     * By default, the modal strategy is used.\n     * It will display types, inputs, mutations and\n     * queries by models\n     *\n     * Go to the package documentation to see\n     * all the supported strategies.\n     */\n    'strategy' =\u003e ModelStrategy::class,\n];\n```\n\n## Testing\n\n```bash\ncomposer test\n```\n\n## Changelog\n\nPlease see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.\n\n## Contributing\n\nPlease see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.\n\n## Security Vulnerabilities\n\nPlease review [our security policy](../../security/policy) on how to report security vulnerabilities.\n\n## Credits\n\n- [Axel Charpentier](https://github.com/axeldotdev)\n- [All Contributors](../../contributors)\n\n## License\n\nThe MIT License (MIT). Please see [License File](LICENSE.md) for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faxeldotdev%2Flaravel-graphql-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faxeldotdev%2Flaravel-graphql-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faxeldotdev%2Flaravel-graphql-docs/lists"}