{"id":19646146,"url":"https://github.com/yoctol/fetch-graphql-schema","last_synced_at":"2025-04-28T15:30:28.714Z","repository":{"id":57234582,"uuid":"73482344","full_name":"Yoctol/fetch-graphql-schema","owner":"Yoctol","description":"fetch GraphQL schema via introspection query","archived":false,"fork":false,"pushed_at":"2020-09-21T03:28:14.000Z","size":13,"stargazers_count":28,"open_issues_count":6,"forks_count":4,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-04-20T02:12:13.110Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/Yoctol.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-11-11T14:03:55.000Z","updated_at":"2024-11-14T23:04:35.000Z","dependencies_parsed_at":"2022-09-15T04:12:29.253Z","dependency_job_id":null,"html_url":"https://github.com/Yoctol/fetch-graphql-schema","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Yoctol%2Ffetch-graphql-schema","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Yoctol%2Ffetch-graphql-schema/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Yoctol%2Ffetch-graphql-schema/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Yoctol%2Ffetch-graphql-schema/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Yoctol","download_url":"https://codeload.github.com/Yoctol/fetch-graphql-schema/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251338492,"owners_count":21573566,"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-11T14:37:05.281Z","updated_at":"2025-04-28T15:30:28.487Z","avatar_url":"https://github.com/Yoctol.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# fetch-graphql-schema\n\n[![NPM version][npm-image]][npm-url]\n[![Build Status][travis-image]][travis-url]\n[![Test coverage][coveralls-image]][coveralls-url]\n[![Dependency Status][david_img]][david_site]\n\n\u003e fetch GraphQL schema via introspection query\n\n\n## Install\n\n```\n$ npm install fetch-graphql-schema\n```\n\n\n## Usage\n\n```js\nconst fetchSchema = require('fetch-graphql-schema');\n\nfetchSchema('http://localhost:8080/graphql')\n  .then(schemaJSON =\u003e {\n    /**\n     * {\n     *   \"data\": {\n     *     \"__schema\": {\n     *       \"queryType\": {\n     *         \"name\": \"Query\"\n     *          ....\n     */\n  });\n\nfetchSchema('http://localhost:8080/graphql', { readable: true })\n  .then(clientSchema =\u003e {\n    /**\n     * type User implements Node {\n     *   id: ID!\n     *   name: String!\n     * }\n     */\n  });\n//=\u003e\n```\n\n\n## API\n\n### fetchGraphqlSchema(url, [options])\n\n#### url\n\n*Required*\nType: `string`\n\nURL of GraphQL server.\n\n#### options\n\n##### readable\n\nType: `boolean`\nDefault: `false`\n\nresolve `.graphql` instead of `.json`.\n\n## CLI\n\n#### Usage\n```\n$ fetch-graphql-schema \u003cschemaUrl\u003e\n```\n\n#### Options\n```\n-o, --output    Specify an output filename.\n-r, --readable  Resolve .graphql instead of .json.\n```\n\n#### Examples\n```\n$ fetch-graphql-schema http://api.server/graphql -o schema.json\n$ fetch-graphql-schema http://api.server/graphql -o schema.graphql -r\n```\n\n## License\n\nMIT © [C.T. Lin](https://github.com/Yoctol/fetch-graphql-schema)\n\n[npm-image]: https://badge.fury.io/js/fetch-graphql-schema.svg\n[npm-url]: https://npmjs.org/package/fetch-graphql-schema\n[travis-image]: https://travis-ci.org/Yoctol/fetch-graphql-schema.svg\n[travis-url]: https://travis-ci.org/Yoctol/fetch-graphql-schema\n[coveralls-image]: https://coveralls.io/repos/Yoctol/fetch-graphql-schema/badge.svg?branch=master\u0026service=github\n[coveralls-url]: https://coveralls.io/r/Yoctol/fetch-graphql-schema?branch=master\n[david_img]: https://david-dm.org/Yoctol/fetch-graphql-schema.svg\n[david_site]: https://david-dm.org/Yoctol/fetch-graphql-schema\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyoctol%2Ffetch-graphql-schema","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyoctol%2Ffetch-graphql-schema","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyoctol%2Ffetch-graphql-schema/lists"}