创建端点

端点是 Apidog 中 API 的基本构建块。本指南介绍如何创建和指定端点，帮助你有效定义 API 规范。

什么是端点？

端点表示一个可通过 HTTP 调用的单个 API 操作。每个端点包括：

组件	描述	示例
HTTP 方法	要执行的操作	`GET`, `POST`, `PUT`, `DELETE`
路径	相对于基础 URL 的 URL 路径	`/users/{id}`
参数	路径、查询、头部或主体参数	`id`（路径参数）
请求主体	随请求发送的数据（用于 POST/PUT）	JSON schema
响应	预期的响应格式和状态码	`200 OK`, `404 Not Found`

关键概念

Apidog 端点是规范驱动的。当你定义一个端点时，你同时在创建文档和一个可测试的接口，该接口会自动生成请求。

前提条件

在创建端点之前，请确保你已具备：

一个 Apidog account 以及 Apidog client application

对 HTTP 方法和 API 概念的基本了解

已在 Apidog 中创建一个你想要添加端点的项目，更多信息请查看 Overview 页面。

快速开始：创建基础端点

导航到 APIs 模块：点击侧边栏中的 “APIs” 选项卡

创建新端点：

点击 New HTTP Endpoint 按钮，或点击目录树中的 +，然后选择 New HTTP Endpoint

选择目标模块 / 文件夹

此操作会让你进入设计优先模式（你也可以在发起请求前手动切换到该模式），在该模式中你会先定义 API 规范。

端点创建方法

方法	使用场景	步骤
手动创建	从零开始	1. 右键点击文件夹 → “New Endpoint” 2. 填写方法和路径 3. 定义参数和响应
从代码导入	已有 API 代码	1. 使用 “Import” 功能 2. 上传 OpenAPI/Swagger 文件 3. 映射到模块
从请求创建	测试已有 API	1. 先发送一个请求 2. 点击 “Save” 3. 完善规范
克隆现有端点	相似端点	1. 右键点击端点 → “Duplicate” 2. 修改路径和参数

指定端点详情

基本信息

每个端点都需要：

名称：描述性标题（例如，“Get User Profile”）

方法：HTTP 动词

路径：包含参数的 URL 路径

描述：端点的作用

参数

在 Apidog 工作台中，你可以按如下方式定义用于自定义端点行为的参数（取值仅用作示例）：

路径参数

用于 URL 路径本身：

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

参数	类型	必填	描述
`userId`	integer	是	唯一用户标识符
`postId`	integer	是	帖子标识符

查询参数

可选筛选条件和分页：

参数	类型	必填	默认值	描述
`limit`	integer	否	10	要返回的结果数量
`offset`	integer	否	0	要跳过的结果数量
`status`	string	否	active	按状态筛选

请求主体（用于 POST/PUT）

使用 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"]
}

响应

定义所有可能的响应格式：

成功响应（200 OK）

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

错误响应

状态码	描述	Schema
`400`	Bad Request	错误详情
`401`	Unauthorized	认证错误
`404`	Not Found	资源未找到
`500`	Internal Server Error	服务器错误详情

Design 选项卡包含扩展的 API 规范选项。

下一步

发起请求

创建端点

什么是端点？#

创建端点#

前提条件#

快速开始：创建基础端点#

端点创建方法#

指定端点详情#

基本信息#

参数#

路径参数#

查询参数#

请求主体（用于 POST/PUT）#

响应#

成功响应（200 OK）#

错误响应#

什么是端点？

创建端点

前提条件

快速开始：创建基础端点

端点创建方法

指定端点详情

基本信息

参数

路径参数

查询参数

请求主体（用于 POST/PUT）

响应

成功响应（200 OK）

错误响应