Making Requests from Spec

In the previous chapters, we've explored the theoretical foundations of APIs and learned about their individual components—methods, paths, parameters, request bodies, and responses. Now, as someone new to the API world, it's time to see how these pieces come together to build real functionality.

This chapter focuses on Working with APIs—the practical process of using APIs to solve real problems and accomplish tasks. We'll start with the most fundamental skill: how to make requests from an API specification in Apidog.

Instead of manually constructing requests from scratch, working from a spec ensures you're using the API correctly and helps you avoid common mistakes. If you haven't imported an API spec into Apidog yet, you can learn how to do so in the previous article: What is an API Specification?.

1. Making a GET Request from Spec

Let's start with a simple example: retrieving a pet by its ID using the Pet Store API. This demonstrates how to work with a GET request that includes a path parameter.

Step 1: Open the Endpoint

In your Apidog project, navigate to the imported Pet Store API spec.

Find the "Get a pet" endpoint (or GET /pets/{id}).

Click on it to open the endpoint details.

Step 2: Switch to the Run Tab

Once the endpoint is open, you'll see multiple tabs at the top:

Edit — for viewing or modifying the endpoint specification

Run — for sending requests

Preview — for viewing the spec in different formats

Click on the "Run" tab to switch to the request interface.

Step 3: Fill in the Path Parameter

In the Run tab, you'll see the request is automatically generated based on the spec. For the GET /pets/{id} endpoint:

The method is already set to GET

The path shows /pets/{id} with the path parameter {id} highlighted

If the spec includes an example value (like '1'), it may already be filled in

Enter a pet ID in the path parameter field. For example, type pet_1Nv0FGQ9RKHgCVdK to retrieve the pet with that ID.

Step 4: Send the Request

Make sure you've selected the correct environment in the top-right corner (if your project uses environments).

Click the "Send" button.

The response will appear in the lower panel, showing the status code, response time, and the JSON body with the pet's information.

2. Making a POST Request from Spec

Now let's try a more complex example: creating a new pet using a POST request with a request body. This shows how to work with endpoints that require data to be sent.

Step 1: Open the Endpoint

Navigate to the "Create a pet" endpoint (or POST /pets) in your Apidog project.

Click on it to open the endpoint.

Step 2: Switch to the Run Tab

Click the "Run" tab to access the request interface.

Step 3: Review the Auto-Generated Request Body

When you switch to the Run tab, Apidog automatically generates a request body based on the spec's schema. If the spec includes an example, it will be pre-filled. Otherwise, you'll see a structure matching the schema.

Step 4: Fill in the Request Body

The request body for creating a pet typically includes fields like:

name — the pet's name (e.g., "Luna")

species — the pet's species (e.g., "DOG", "CAT")

breed — the pet's breed (e.g., "Golden Retriever")

ageMonths — the pet's age in months

status — the pet's status (e.g., "AVAILABLE", "PENDING", "ADOPTED")

You can:

Edit the auto-generated values directly in the JSON editor

Click "Auto-generate" to create new sample data based on the schema

Manually type your own values

Example request body:

{
  "name": "Luna",
  "species": "DOG",
  "breed": "Golden Retriever",
  "ageMonths": 24,
  "size": "LARGE",
  "color": "Golden",
  "gender": "FEMALE",
  "goodWithKids": true,
  "goodWithPets": true,
  "adoptionFee": 150.00,
  "description": "Friendly golden retriever looking for an active family",
  "status": "AVAILABLE"
}

Step 5: Send the Request

Verify your request body is correctly formatted.

Click "Send" to create the pet.

Check the response—you should receive a 201 Created status with the created pet's information, or see any error messages if something went wrong.

3. Save as Endpoint Case (Optional)

After sending a successful request, you can save it as an endpoint case for future use:

Click the "Save as case" button (located next to the "Send" button).

In the dialog that appears:

Enter a name for the case (e.g., "Get pet by ID - Luna")

Optionally, check "Save response" to also save the response data

Click "Save".

The saved case will appear under the endpoint in your project tree, making it easy to reuse this specific request configuration later.

4. Key Takeaways

Working with APIs is about using API components to solve real problems and build functionality.

Working from specs ensures accuracy and saves time by auto-generating requests.

To make requests in Apidog:

Import the API spec (if not already done)

Open the endpoint you want to use

Switch to the "Run" tab

Fill in any required parameters or request body

Click "Send" to execute the request

Optionally, click "Save as case" to save the request for future use

GET requests typically use path or query parameters.

POST requests usually require a request body with structured data.

Endpoint cases allow you to save specific request configurations for reuse.

Apidog automatically generates requests based on the spec, making it easy to test APIs correctly.

Now that you know how to make basic requests from specs, you're ready to explore more advanced techniques for building real-world solutions. In the next article, we'll learn about Environments and Variables—how to manage different environments and use variables to make your requests more flexible and reusable.

Making Requests from Spec

1. Making a GET Request from Spec#

Step 1: Open the Endpoint#

Step 2: Switch to the Run Tab#

Step 3: Fill in the Path Parameter#

Step 4: Send the Request#

2. Making a POST Request from Spec#

Step 1: Open the Endpoint#

Step 2: Switch to the Run Tab#

Step 3: Review the Auto-Generated Request Body#

Step 4: Fill in the Request Body#

Step 5: Send the Request#

3. Save as Endpoint Case (Optional)#

4. Key Takeaways#

1. Making a GET Request from Spec

Step 1: Open the Endpoint

Step 2: Switch to the Run Tab

Step 3: Fill in the Path Parameter

Step 4: Send the Request

2. Making a POST Request from Spec

Step 1: Open the Endpoint

Step 2: Switch to the Run Tab

Step 3: Review the Auto-Generated Request Body

Step 4: Fill in the Request Body

Step 5: Send the Request

3. Save as Endpoint Case (Optional)

4. Key Takeaways