Registry / devops / tmp-graphql-config-extension-openapi

tmp-graphql-config-extension-openapi

JSON →
library1.0.7jsnpmunverified

A plugin for GraphQL Config that patches endpoints into a GraphQL Config instance based on an OpenAPI/Swagger definition. Version 1.0.7 is the latest stable. It enables GraphQL CLI tools to retrieve schemas from OpenAPI endpoints by injecting the necessary URL and headers into the config. This extension is primarily used with graphql-config and graphql-cli. It supports ESM imports and ships TypeScript definitions. Compared to alternatives, it integrates directly with the GraphQL Config ecosystem.

devops
npm install tmp-graphql-config-extension-openapi
github ↗package ↗homepage ↗
INSTALL
IMPORT
SIG · TMP-GRAPHQL-CONFIG
T
tmp-graphql-config-extension-openapi
devopsjavascriptv1.0.7
harness data pending
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')
Package is ESM-only; CommonJS require will fail. Use dynamic import if needed.
default import
✓ import graphqlConfigExtensionOpenapi from 'graphql-config-extension-openapi'
No default export; named import only.
type imports
✓ import type { PatchEndpointsToConfigOptions } from 'graphql-config-extension-openapi'
Types are available via TypeScript.

Demonstrates how to patch endpoints into a GraphQL config using an OpenAPI definition.

import { patchEndpointsToConfig } from 'graphql-config-extension-openapi'; import { getGraphQLConfig } from 'graphql-config'; const config = getGraphQLConfig().config; const patchedConfig = patchEndpointsToConfig(config, process.cwd()); // Now config has endpoints from OpenAPI definition console.log(patchedConfig);
Debug
Known issues
gotchaThe package is ESM-only. Using require() will throw an error.
fix
Use import syntax or dynamic import.
affects: >=1.0.0
gotchaThe package does not have a default export. Attempting to import default will result in undefined.
fix
Use named import { patchEndpointsToConfig }.
affects: >=1.0.0
deprecatedThe package expects a graphql-config instance with a specific shape. Changes in graphql-config major versions may break.
fix
Ensure graphql-config is compatible (e.g., version 3.x).
affects: >=1.0.0
Errors
Common errors & fixes
ERR_REQUIRE_ESM: require() of ES Module not supported
Using CommonJS require() on an ESM-only package.
fix
Switch to import syntax or use dynamic import: import('graphql-config-extension-openapi')
TypeError: patchEndpointsToConfig is not a function
Default import returns undefined because the package has no default export.
fix
Use named import: import { patchEndpointsToConfig } from 'graphql-config-extension-openapi'
Module not found: Can't resolve 'graphql-config'
Missing peer dependency graphql-config.
fix
Install graphql-config: npm install graphql-config
Upgrade
Version history
1.0.7latest on npm
Audit
Dependencies

No dependency data recorded yet.

Agent activity
4 hits · last 30 days
node
4
Resources
githubhttps://github.com/graphql-config/graphql-config-extension-openapi ↗
packagetmp-graphql-config-extension-openapi ↗
homepagehttps://github.com/graphql-config/graphql-config-extension-openapi#readme ↗
tmp-graphql-config-extension-openapi — npm install tmp-graphql-config-extension-openapi · libregistry