The Guild LogoThe Guild Monogram

Search docs

Search icon

Products by The Guild

Products

Hive logoHive blurred logo

Hive

Schema Registry for your GraphQL Workflows

Skip to main content

SOAP

image

This handler allows you to consume SOAP WSDL files and generate a remote executable schema for those services.

To get started, install the handler library from NPM:

$ yarn add @graphql-mesh/soap

Now, you can use it directly in your Mesh config file:

sources:
- name: CountryInfo
handler:
soap:
wsdl: http://webservices.oorsprong.org/websamples.countryinfo/CountryInfoService.wso?WSDL

Codesandbox Example#

You can check out our example that uses SOAP Handler.

Config API Reference#

  • wsdl (type: String, required) - A url to your WSDL
  • basicAuth (type: Object) - Basic Authentication Configuration Including username and password fields:
    • username (type: String, required) - Username for Basic Authentication
    • password (type: String, required) - Password for Basic Authentication
  • securityCert (type: Object) - SSL Certificate Based Authentication Configuration Including public key, private key and password fields:
    • publicKey (type: String) - Your public key
    • privateKey (type: String) - Your private key
    • password (type: String) - Password
    • publicKeyPath (type: String) - Path to the file or URL contains your public key
    • privateKeyPath (type: String) - Path to the file or URL contains your private key
    • passwordPath (type: String) - Path to the file or URL contains your password
  • schemaHeaders (type: Any) - JSON object representing the Headers to add to the runtime of the API calls only for schema introspection You can also provide .js or .ts file path that exports schemaHeaders as an object
  • operationHeaders (type: JSON) - JSON object representing the Headers to add to the runtime of the API calls only for operation during runtime