📄️ Getting Started with Data Equity Studio: The Basics
In Data Equity Studio, the foundation of API design begins with creating Data Types, which represent your RESTful resources. Think of Data Types as the blueprint for the structure and behavior of the data your API will handle.
📄️ How to Create and Deploy an API
Follow these simple steps to design, mock, and deploy your API using the intuitive UI of Data Equity Studio.
📄️ Step 1: Create a New API Design
To start designing your API, follow these simple steps:
📄️ Step 2: Define the API Design
Now that your API is created, it’s time to define its structure and functionality.
📄️ Step 2.2: Add Properties to Your Data Type
Properties are essential components of your Data Type. They define the attributes of the resource and represent the data that will be sent or received as part of RESTful requests and responses.
📄️ Step 3: Add a Path to Your API
Paths represent the RESTful URLs that host your API endpoints. These define how users and systems interact with your API resources.
📄️ Step 3.2: Add an Operation to Your Path
Operations define the actions your API can perform on a resource and are represented by HTTP verbs like GET, POST, PUT, and DELETE.
📄️ Step 3.3: Add a Response to Your Operation
Responses define what your API returns after performing an operation. In Data Equity Studio, responses are currently supported in the JSON format.
📄️ Step 3.4: Add a Media Type to Your Operation
Responses define what your API returns after performing an operation. In Data Equity Studio, responses are currently supported in the JSON format.
📄️ Step 4: Configure Policies and Deploy the API
The final step in your API design process is to configure policies and deploy your API. This ensures your API is ready for use, with optional rules like security, rate limits, or caching.
📄️ Step 5: Test the API with the Mock URL
After successfully deploying your API in Data Equity Studio, you will receive a Mock URL in the Properties section. This mock URL represents the endpoint for your API, where you can interact with it using popular tools like Postman or any other HTTP client.