Skip to main content

Step 2: Define the API Design

Now that your API is created, it’s time to define its structure and functionality.

Start Defining the API Design​

  1. Enter the API Editor:

    • Click on the Edit API button to open the API design interface. Docs Version Dropdown

  2. Explore the Design Options:

    • On the left-hand side of the UI, you’ll find two key options:
      1. Add Paths: Define the RESTful URLs that host your API endpoints.
      2. Add Data Types: Create the resource structures your API will expose.

Step 2.1: Add Data Types​

Data Types are the RESTful resources your API will handle, representing the data structure and attributes.

  1. Add a New Data Type:

    • Click on the Add Data Type button. Docs Version Dropdown
    • Provide a meaningful name for the Data Type (e.g., User, Product, or Order).
    • Click Save to confirm.

  2. Data Types in Context:

    • Think of Data Types as the foundation of your API. They define the shape of the data being sent or received through your endpoints. Docs Version Dropdown

At this stage, your Data Type is created and ready for further customization. The next step involves adding properties to your Data Type, which represent the resource’s attributes. Let’s continue!