Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
60 changes: 60 additions & 0 deletions en/docs/create-api-proxy/my-apis/graphql/import-api-contract.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# Import API Contract

A GraphQL API proxy operates based on the GraphQL query language specification. GraphQL provides a flexible and efficient approach to API development by allowing clients to request exactly the data they need, nothing more and nothing less.

Unlike traditional REST APIs that require multiple endpoints for different resources, GraphQL uses a single endpoint and a type system to define the API's capabilities. This enables clients to compose complex queries that fetch related data in a single request, reducing over-fetching and under-fetching of data. GraphQL is ideal for applications that need flexible data fetching and efficient data aggregation.

In this guide, you will:

- Create a GraphQL API proxy.
- Configure and Deploy the API proxy.
- Test the API proxy to verify its functionality.

## Prerequisites

- If you're signing in to the Bijira Console for the first time, create an organization:
1. Go to [Bijira Console](https://console.bijira.dev/) and sign in using your preferred method.
2. Enter a unique organization name. For example, `Stark Industries`.
3. Read and accept the privacy policy and terms of use.
4. Click **Create**.

This creates the organization and opens the **Project Home** page of the default project created for you.

## Create an API Proxy

In this guide, you will use a sample URL to import a GraphQL schema definition and create a GraphQL API proxy.

1. Go to [Bijira Console](https://console.bijira.dev/) and sign in. This opens the project home page.
2. If you already have one or more components in your project, click + Create. Otherwise, proceed to the next step.
3. Select **Import API Contract**.
4. Select the API Type as **GraphQL**.
5. Select **URL** option and click **Try with Sample URL** to use the sample GraphQL schema URL.

6. Click **Next** and edit pre-defined values as needed. You can keep the default values for this sample.
7. Click **Create** to create the API Proxy. Wait for the setup to complete.

## Configure and Deploy the API Proxy

1. Navigate to the **Deploy** page of the API Proxy.
2. Select **Configure and Deploy** option from the **Deploy** dropdown and click it.
3. Select **External** as API Access Mode.
4. Click **Deploy**.

## Test the API Proxy

1. Navigate to the **Test --> Console** page of the API Proxy.
2. Use the GraphQL Console to test the API Proxy.

## Promote the API Proxy to Production and Publish the API proxy

1. Navigate to the **Deploy** page of the API Proxy.
2. Select **Promote to Production**.
3. In the left navigation menu, click **Lifecycle** under **Develop**. This takes you to the **Lifecycle** page.
4. Click **Publish**.
5. In the **Publish API** dialog, click **Confirm** to proceed with publishing the API. If you want to change the display name, make the necessary changes and then click **Confirm**. This sets the API lifecycle state to **Published**.

## API Proxy Behavior

This GraphQL API Proxy enables clients to query data using GraphQL queries and mutations. Clients can request exactly the fields they need, reducing bandwidth and improving performance. The API supports complex queries that fetch related data in a single request, making it efficient for applications with varying data requirements.


51 changes: 51 additions & 0 deletions en/docs/create-api-proxy/my-apis/graphql/start-with-endpoint.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Create API proxy from Start with Endpoint

A GraphQL API proxy operates based on the GraphQL query language specification. GraphQL provides a flexible and efficient approach to API development by allowing clients to request exactly the data they need, nothing more and nothing less.

Unlike traditional REST APIs that require multiple endpoints for different resources, GraphQL uses a single endpoint and a type system to define the API's capabilities. This enables clients to compose complex queries that fetch related data in a single request, reducing over-fetching and under-fetching of data. GraphQL is ideal for applications that need flexible data fetching, real-time subscriptions, and efficient data aggregation.

## Prerequisites

- If you're signing in to the Bijira Console for the first time, create an organization:
1. Go to [Bijira Console](https://console.bijira.dev/) and sign in using your preferred method.
2. Enter a unique organization name. For example, `Stark Industries`.
3. Read and accept the privacy policy and terms of use.
4. Click **Create**.

This creates the organization and opens the **Project Home** page of the default project created for you.

## Create an API Proxy

In this guide, you will create a GraphQL API proxy using an endpoint.

1. Go to [Bijira Console](https://console.bijira.dev/) and sign in. This opens the project home page.
2. If you already have one or more components in your project, click + Create. Otherwise, proceed to the next step.
3. Select **Start with Endpoint**.
4. Select the API Type as **GraphQL**.
5. Click **Try with Sample URL** to use the sample GraphQL endpoint URL.

6. Click outside the input field or press Tab to validate the endpoint. Bijira will automatically validate the endpoint and fetch the GraphQL schema through introspection. Wait for the validation to complete.

7. Click **Next**.
8. Edit the pre-defined values as needed. You can keep the default values for this sample.

9. Click **Create** to create the API Proxy. Wait for the setup to complete.

## Configure and Deploy the API Proxy

1. Navigate to the **Deploy** page of the API Proxy.
2. Select **Configure and Deploy** option from the **Deploy** dropdown and click **Configure and Deploy** button.
3. Select **External** as API Access Mode.
4. Click **Deploy**.

## Test the API Proxy

1. Navigate to the **Test --> GraphQL Console** page of the API Proxy.
2. Use the GraphQL Console to test the API Proxy.

## Publish the API proxy

1. In the left navigation menu, click **Lifecycle** under **Develop**. This takes you to the **Lifecycle** page.
2. Click **Publish**.
3. In the **Publish API** dialog, click **Confirm** to proceed with publishing the API. If you want to change the display name, make the necessary changes and then click **Confirm**. This changes the API lifecycle state to **Published**.

17 changes: 17 additions & 0 deletions en/docs/test-api-proxy/graphql-console.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Test GraphQL APIs via the GraphQL Console

Bijira offers an integrated GraphQL Console to test GraphQL API proxies that you create and deploy. Since Bijira secures APIs with OAuth 2.0 authentication, the GraphQL Console generates test keys to help you invoke your GraphQL operations.

Follow these steps to test a GraphQL API proxy using the GraphQL Console:

1. Go to the [Bijira Console](https://console.bijira.dev/) and log in.
2. Select the project and GraphQL API proxy that you want to test.
3. Click **Test** in the left navigation menu, then select **Console**. This will open the **GraphQL Console** pane.

![GraphQL Console](../assets/img/test-api-proxy/graphiql-console.png){.cInlineImage-full}

4. In the **Console** pane, select the desired environment from the drop-down menu.
5. In the query editor, enter the GraphQL operation you want to execute (for example, a `query` or `mutation`).
6. Click **The Play Button**. The response from the GraphQL API proxy will be displayed under the **Response** section.


4 changes: 4 additions & 0 deletions en/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,9 @@ nav:
- Start with Endpoint: create-api-proxy/my-apis/websocket/start-with-endpoint.md
- Start from Scratch: create-api-proxy/my-apis/websocket/start-from-scratch.md
- Limitations: create-api-proxy/my-apis/websocket/quotas-and-limitations.md
- GraphQL APIs:
- Import API Contract: create-api-proxy/my-apis/graphql/import-api-contract.md
- Start with Endpoint: create-api-proxy/my-apis/graphql/start-with-endpoint.md
- Third Party APIs (Egress):
- AI APIs:
- Overview: create-api-proxy/third-party-apis/ai-apis.md
Expand Down Expand Up @@ -145,6 +148,7 @@ nav:
- Test API Proxy:
- OpenAPI Console: test-api-proxy/openapi-console.md
- WebSocket Console: test-api-proxy/ws-test-console.md
- GraphQL Console: test-api-proxy/graphql-console.md
- cURL: test-api-proxy/curl.md
- API Chat: test-api-proxy/api-chat.md
- MCP Servers:
Expand Down