Registry /
devops / graphql-config-extension-openapi
Install & Compatibility
Where this runs
No compatibility data collected yet for this library.
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
patchEndpointsToConfig
✓ import { patchEndpointsToConfig } from 'graphql-config-extension-openapi'
✗ const patchEndpointsToConfig = require('graphql-config-extension-openapi').patchEndpointsToConfig
CommonJS require still works, but recommended import is ESM.
GraphQLConfigData (type)
✓ import { GraphQLConfigData } from 'graphql-config'
✗ import { GraphQLConfigData } from 'graphql-config-extension-openapi'
Type is re-exported from graphql-config, not this package.
default export
✓ import patchEndpointsToConfig from 'graphql-config-extension-openapi'
✗ import * as gqlConfigExt from 'graphql-config-extension-openapi'
Only named export available; default import may be undefined. Check version compatibility.
TypeScript usage
✓ import { patchEndpointsToConfig } from 'graphql-config-extension-openapi'
Package ships TypeScript declarations; use named import for type safety.
Load GraphQL config, patch it with OpenAPI endpoints from the project root, then use the patched config for schema fetching.
import { getGraphQLConfig } from 'graphql-config';
import { patchEndpointsToConfig } from 'graphql-config-extension-openapi';
import { resolve } from 'path';
// Load existing GraphQL config
const config = getGraphQLConfig().config;
// Patch with OpenAPI endpoint
const patchedConfig = patchEndpointsToConfig(config, process.cwd());
console.log('Patched config:', JSON.stringify(patchedConfig, null, 2));
// Now use patchedConfig with graphql-cli or other tools to fetch schema
Errors
Common errors & fixes
TypeError: patchEndpointsToConfig is not a function
Default import used but package exports named export only.
fixUse `import { patchEndpointsToConfig } from 'graphql-config-extension-openapi'` Error: Cannot find module 'graphql-config'
graphql-config is a peer dependency but not installed.
fixRun `npm install graphql-config`
ENOENT: no such file or directory, open 'petstore.json'
OpenAPI definition path is relative to the config file location, but current working directory is different.
fixUse absolute path or ensure the config file is in the project root.
Invalid OpenAPI version: Must be 3.x
OpenAPI definition is Swagger 2.0 or older.
fixConvert to OpenAPI 3.x using swagger2openapi or a similar tool.
Audit
Dependencies
graphql-configrequiredpeer dependency required to provide GraphQLConfigData and getGraphQLConfig
openapi-to-graphqlrequiredruntime dependency to convert OpenAPI schema to GraphQL schema (documented, but not explicit in npm)