Apidog 客户端支持使用 HTTP、GraphQL、SOAP、gRPC 以及其他流行协议发送 API 请求。你可以在 Apidog 中创建请求,发送请求以查看响应,并保存请求用于团队协作。创建新请求#
要在 Apidog 中创建请求,你只需点击 "+" → "New Request"。你可以根据 API 规范,在 Apidog 界面中填写请求的必要部分,例如请求方法、URL、请求参数、授权等。使用此方法,你可以创建 HTTP、GraphQL 和 SOAP 请求。有关创建 WebSocket 和 gRPC 请求的更多信息,请参阅相应协议的文档。请求 URL#
要在 Apidog 中发起请求,你需要指定表示你要连接的 API 端点的 URL。你可以通过 API 执行的每个操作通常都与一个端点相关联,而该端点具有特定的 URL。如果你正在构建 API:URL 通常由基础位置加路径组成。例如,在请求 URL https://api.example.com/user/12 中,https://api.example.com 是基础 URL,/user/12 是端点路径。
如果你正在使用公共 API:你的 API 提供方会在其开发者文档中提供你所需的 URL。
你可以在 URL 字段中输入查询参数,也可以在 Params 标签页中输入。如果你的请求使用路径参数,可以在 URL 字段中输入它们。如果你没有指定协议,Apidog 会自动在你的 URL 开头添加 http://。
请求方法#
在 Apidog 中,你可以在请求 URL 左侧选择要使用的请求方法。默认方法为 GET。常见 HTTP 方法#
| 方法 | 用途 | 对数据的影响 |
|---|
| GET | 从指定资源检索数据 | 只读,无副作用 |
| POST | 将数据提交到指定资源进行处理 | 创建新资源 |
| PUT | 更新现有资源 | 替换整个资源 |
| PATCH | 对资源应用部分修改 | 更新特定字段 |
| DELETE | 请求删除资源 | 移除资源 |
在 API 设计中,同一个 URL 可以使用不同的方法请求,表示对同一资源执行不同操作。例如,GET /user/{id} 通常会检索此 id 对应的用户信息,而 PUT /user/{id} 会更新此 id 对应的用户信息。发送请求#
在指定请求协议、方法和 URL 后,添加你要发送请求的 API 所需的任何其他详细信息:参数和主体:提供需要随请求一起发送的任何参数、主体数据或请求头部。
Cookies:你也可以通过选择 Cookies 标签页,在请求中使用 cookies。
输入所有请求详细信息后,选择 Send 将请求发送到 API 服务器。你可以在响应窗格中查看服务器返回的 响应。你可以在侧边栏的 History 中查看已发送的请求,并再次发送它们。这对于调试以及比较不同时间的响应非常有用。