Update wiki Home page for graphql
parent
6ee4d3f436
commit
a22d7e3844
50
Home.md
50
Home.md
@ -1,21 +1,43 @@
|
|||||||
# Deploy the Project on CamelX Platform
|
# GraphQL
|
||||||
|
|
||||||
Deploy on CamelX Platform in three steps
|
Send GraphQL queries and mutations to external systems.
|
||||||
|
|
||||||
## Step 1: Create a release
|
## Metadata
|
||||||
From the project space, click on **"Create a release"**
|
|
||||||
|
|
||||||
The new version is automatically available in the list
|
| Property | Value |
|
||||||
|
|----------|-------|
|
||||||
|
| Scheme | `graphql` |
|
||||||
|
| Support Level | Stable |
|
||||||
|
| Labels | api |
|
||||||
|
| Version | 4.20.0 (CEQ 3.36.0) |
|
||||||
|
|
||||||
## Step 2: Deploy
|
## Maven Dependency
|
||||||
Click on **"Deploy"**
|
|
||||||
|
|
||||||
- **Version:** Select the desired release
|
```xml
|
||||||
- **Environment:** Choose `Development`, `Staging`, or `Production`
|
<dependency>
|
||||||
- **Configuration:** Select the configuration source
|
<groupId>org.apache.camel.quarkus</groupId>
|
||||||
- **Resources:** Set CPU and Memory
|
<artifactId>camel-quarkus-graphql</artifactId>
|
||||||
|
<version>4.20.0 (CEQ 3.36.0)</version>
|
||||||
|
</dependency>
|
||||||
|
```
|
||||||
|
|
||||||
## Step 3: Expose
|
## Endpoint Properties
|
||||||
Enable **"Expose"**
|
|
||||||
|
|
||||||
Choose an **API Gateway** (Internal, Public, etc.)
|
| Name | Type | Required | Default | Description |
|
||||||
|
|------|------|----------|---------|-------------|
|
||||||
|
| `httpUri` | string | ✓ | | The GraphQL server URI. |
|
||||||
|
| `headerFilterStrategy` | object | | | To use a custom HeaderFilterStrategy to filter header to and from Camel message. |
|
||||||
|
| `operationName` | string | | | The query or mutation name. |
|
||||||
|
| `proxyHost` | string | | | The proxy host in the format hostname:port. |
|
||||||
|
| `query` | string | | | The query text. |
|
||||||
|
| `queryFile` | string | | | The query file name located in the classpath (or use file: to load from file system). |
|
||||||
|
| `queryHeader` | string | | | The name of a header containing the GraphQL query. |
|
||||||
|
| `throwExceptionOnFailure` | boolean | | `true` | Option to disable throwing the HttpOperationFailedException in case of failed responses from the remote server. This allows you to get all responses regardless of the HTTP status code. |
|
||||||
|
| `variables` | object | | | The JsonObject instance containing the operation variables. |
|
||||||
|
| `variablesHeader` | string | | | The name of a header containing a JsonObject instance containing the operation variables. |
|
||||||
|
| `lazyStartProducer` | boolean | | `false` | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. |
|
||||||
|
| `httpClient` | object | | | To use a custom pre-existing Http Client. Beware that when using this, then other configurations such as proxy, access token, is not applied and all this must be pre-configured on the Http Client. |
|
||||||
|
| `accessToken` | string | | | The access token sent in the Authorization header. |
|
||||||
|
| `jwtAuthorizationType` | string | | `Bearer` | The JWT Authorization type. Default is Bearer. |
|
||||||
|
| `password` | string | | | The password for Basic authentication. |
|
||||||
|
| `username` | string | | | The username for Basic authentication. |
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user