A. Using Environment to Deploy REST API
- Create a environment: Create a new environment such as
production,etc based on the functionality. This environment helps to managed the development of the API.
Visit the docs to learn more about creating environments
- Build Your REST API: Begin by designing and creating your REST API according to your application’s requirements.
-
Push to Deployment: Once your API is ready and tested, a single click is all it takes to deploy it. Simply hit the
Deploybutton, and your API will be pushed to the designated environment.
-
Accessing the API: After deployment, your REST API can be accessed via a specific URL. The format is
{base_url}/{env_name}/{api_name}, ensuring a straightforward and consistent way to interact with your services.
Details tab of the RestAPI Builder page.
B. Using Environment to Deploy GraphQL
- Create a environment: Create a new environment such as
stag,etc based on the functionality. This environment helps to managed the development of the API.
- List Tables: Start by using our connectors to list the tables from your database. Our AI Schema Builder will assist you in tracking all fields across these tables.
Visit the docs to learn more about GraphQL AI Schema Builder
- Automatic Schema Generation: Once the tables are listed, our platform automatically generates the GraphQL schema. This schema defines the structure of your data and the queries and mutations you can perform.
-
Automatic Deployment: The generated schema is
automatically pushedto the GraphQL environment. This seamless process ensures that your GraphQL API is immediately ready for use without manual intervention. - Requesting the API: You can now use the environment-specific URL to make requests to your GraphQL API, just as you would with a REST API.
Benefits of Using Our Platform
- Isolation: Utilising Separate environments for REST and GraphQL APIs ensure optimal performance and security.
- Simplicity: A single click for deployment reduces complexity and saves time.
- Efficiency: Automatic schema generation and deployment for GraphQL APIs streamline the setup process.