README
¶
HTTP Connector
HTTP Connector allows you to quickly convert HTTP APIs to NDC schema and proxy requests from GraphQL Engine v3 to remote services. The connector can automatically transform OpenAPI 2.0 and 3.0 definitions to NDC schema.
[!NOTE] HTTP connector is configuration-based HTTP engine and isn't limited to the OpenAPI specs only. Use OpenAPI Connector if you want to take more control of OpenAPI via code generation.
Features
- No code. Configuration based.
- Composable API collections.
- Supported many API specifications.
- Supported authentication.
- Supported headers forwarding.
- Supported argument presets.
- Supported timeout and retry.
- Supported concurrency and sending distributed requests to multiple servers.
- GraphQL-to-REST proxy.
Supported request types
| Request Type | Query | Path | Body | Headers |
|---|---|---|---|---|
| GET | ✅ | ✅ | NA | ✅ |
| POST | ✅ | ✅ | ✅ | ✅ |
| DELETE | ✅ | ✅ | ✅ | ✅ |
| PUT | ✅ | ✅ | ✅ | ✅ |
| PATCH | ✅ | ✅ | ✅ | ✅ |
Supported content types
| Content Type | Supported |
|---|---|
| application/json | ✅ |
| application/xml | ✅ |
| application/x-www-form-urlencoded | ✅ |
| multipart/form-data | ✅ |
| application/octet-stream | ✅ (*) |
| text/* | ✅ |
| application/x-ndjson | ✅ |
| image/* | ✅ (*) |
*: Upload file content types are converted to base64 encoding.
Supported authentication
| Security scheme | Supported | Comment |
|---|---|---|
| API Key | ✅ | |
| Basic Auth | ✅ | |
| Bearer Auth | ✅ | |
| Cookies | ✅ | Require forwarding the Cookie header from the Hasura engine. |
| OAuth 2.0 | ✅ | Built-in support for the client_credentials grant. Other grant types require forwarding access tokens from headers by the Hasura engine |
| mTLS | ✅ |
Get Started
Follow the Quick Start Guide in Hasura DDN docs. At the Connect to data step, choose the hasura/http data connector from the dropdown. The connector template includes an example that is ready to run.
Documentation
- Configuration
- Authentication
- Argument Presets
- Schemaless Requests
- Distributed Execution
- Recipes: You can find or request pre-built configuration recipes of popular API services here.
- NDC HTTP schema
License
HTTP Connector is available under the Apache License 2.0.
Directories