Build GraphQL API Easily on Cloud using Apito
Apito is a powerful Headless CMS on Cloud which helps you build API quickly. You can think of it as a WordPress alternative. This guide will show you how to use Apito to build API for your next project or application.
Let's discuss this step-by-step
First, Create your project
Once you logged in to Apito Console
you will find a Project Space below. You can use this space to switch between your projects or create a new one.
Now, for this quick-started guide I will be creating an API for an eCommerce project, so let's get started.
Click on the Start a new Project
button to initialize your project creation. Enter your project name and description and click Continue. On the next page select
Apito Cloud option to create your project faster. Other Database options will soon be available. Congratulation! your project is being built. Once it’s done you can click Explore new project to switch to your newly created project and start building your API instantly.
The first step after creating your project is to define your project models. The most important part of designing an API is Database Modeling. Let’s start by creating our first model. We all know Products and categories are a crucial part of an eCommerce API.
Second, Model your Database with models & fields
Click on the Models Tab in the top navigation menu. Then from the left sidebar, click on Add a model button. Now, write down the name of the model, in our case, it will be `product`. Now click on the create button.
Next, we will add a few fields to our newly created product model.
Supported Fields Type
To add fields to a model click on the Add a Field button. First, we will add a title field of type text and we will set the attribute of the title to require. Then, a description field of type, Rich Text. An Image field of type, Media. A Price field of type, Number. And last but not least a Rating field of type, Number. Now let’s create another model named Category and add a few fields to it. Those fields will be the name, label, and icons. {data.app} model & field builder is very versatile you can use it to design complex and nested model structures.
Relations Between Models ( One-to-One, Many-to-Many, etc.)
Next, we will create relations between them. For that, you need to click on the Add Field Button and then select Relations. Your relation creation between models depends on your project requirements.
For now, let’s say, Product has many categories and categories have many products. Wow, as you can see, how easy it is to create entity relations between models in Apito. Also, you can rename, delete and create fields & relations anytime you want. Now, that our database design of product and category model with relation is created, we are ready to insert some contents.
Third, Insert your content
Click on the Contents tab and select your model. As you can see, Tables and forms are auto-generated based on your database model design. Let me insert a few products and categories into our database. To add a new product, click on the Add a new product button, which is on the right side of the product content table. You will be able to see a drawer pops up from the right side of our table, which contains an auto-generated specialized input form based on your model design.
Let’s add our first product using this form into our database. Let’s add our first category to our database. As you can see while creating a category you can directly tag products with it. As you can see that product and category are now linked with each other.
Explore Both GraphQL & REST API
Our Ecommerce API is ready. To explore our API let's goto API Explorer
from the top of the navigation menu. As you can see, our GraphQL & REST API is ready for use. Let’s run our first query. We will now Search a product that contains blue in its name
. Now click Run and as you can see it's working! our eCommerce API is ready for integration.
You can also use REST API if your project requires it. Apito Generates a Swagger Documentation which is compatible with OpenAPI.