Creating an Endpoint

Endpoints are the fundamental building blocks of APIs in Apidog. This guide introduces how to create and specify endpoints, helping you define your API specifications effectively.

What is an Endpoint?

An endpoint represents a single API operation that can be invoked via HTTP. Each endpoint consists of:

Component	Description	Example
HTTP Method	The action to perform	`GET`, `POST`, `PUT`, `DELETE`
Path	The URL path relative to base URL	`/users/{id}`
Parameters	Path, query, header, or body parameters	`id` (path parameter)
Request Body	Data sent with the request (for POST/PUT)	JSON schema
Responses	Expected response formats and status codes	`200 OK`, `404 Not Found`

Key Concept

Unlike traditional API tools, Apidog endpoints are specification-driven. When you define an endpoint, you're creating both documentation and a testable interface that automatically generates requests.

Creating Endpoints

Prerequisites

Before creating endpoints, ensure you have:

An Apidog account and the Apidog client application

Basic understanding of HTTP methods and API concepts

A project created in Apidog where you want to add endpoints, check out the Overview page for more information.

Quick Start: Basic Endpoint Creation

Navigate to APIs Module: Click the "APIs" tab in the sidebar

Create New Endpoint:

Click New HTTP Endpoint button or + in the directory tree then New HTTP Endpoint

Select the target module / folder

This action places you in Design-first Mode (or you can manually do so before making a request), where you define the API specification first.

Endpoint Creation Methods

Method	When to Use	Steps
Manual Creation	Starting from scratch	1. Right-click folder → "New Endpoint" 2. Fill in method and path 3. Define parameters and responses
Import from Code	Existing API code	1. Use "Import" feature 2. Upload OpenAPI/Swagger file 3. Map to modules
From Request	Testing existing APIs	1. First send a request 2. Click "Save" 3. Refine the specification
Clone Existing	Similar endpoints	1. Right-click endpoint → "Duplicate" 2. Modify path and parameters

Specifying Endpoint Details

Basic Information

Every endpoint requires:

Name: Descriptive title (e.g., "Get User Profile")

Method: HTTP verb

Path: URL path with parameters

Description: What the endpoint does

Parameters

In the Apidog workbench, you can define parameters that customize the endpoint behavior as follows (values are used only as examples):

Path Parameters

Used in the URL path itself:

GET /users/{userId}/posts/{postId}

Parameter	Type	Required	Description
`userId`	integer	Yes	Unique user identifier
`postId`	integer	Yes	Post identifier

Query Parameters

Optional filters and pagination:

Parameter	Type	Required	Default	Description
`limit`	integer	No	10	Number of results to return
`offset`	integer	No	0	Number of results to skip
`status`	string	No	active	Filter by status

Request Body (for POST/PUT)

Define the expected input data using JSON Schema:

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "User's full name"
    },
    "email": {
      "type": "string",
      "format": "email",
      "description": "User's email address"
    }
  },
  "required": ["name", "email"]
}

Responses

Define all possible response formats:

Success Response (200 OK)

{
  "id": 123,
  "name": "John Doe",
  "email": "john@example.com",
  "createdAt": "2023-01-15T10:30:00Z"
}

Error Responses

Status Code	Description	Schema
`400`	Bad Request	Error details
`401`	Unauthorized	Authentication error
`404`	Not Found	Resource not found
`500`	Internal Server Error	Server error details

The Design tap includes extended API specification options.

Next Step

Make a Request

What is an Endpoint?#

Creating Endpoints#

Prerequisites#

Quick Start: Basic Endpoint Creation#

Endpoint Creation Methods#

Specifying Endpoint Details#

Basic Information#

Parameters#

Path Parameters#

Query Parameters#

Request Body (for POST/PUT)#

Responses#

Success Response (200 OK)#

Error Responses#

What is an Endpoint?

Creating Endpoints

Prerequisites

Quick Start: Basic Endpoint Creation

Endpoint Creation Methods

Specifying Endpoint Details

Basic Information

Parameters

Path Parameters

Query Parameters

Request Body (for POST/PUT)

Responses

Success Response (200 OK)

Error Responses