API 文档工具 | 邮差 --- API Documentation Tool | Postman
发送你的第一个接口请求
- 打开Postman: 启动已安装的Postman应用。
- 创建新请求: 点击主界面左上角的“New”按钮,选择“HTTP Request”。
- 填写请求信息:
- 方法(Method): 在下拉菜单中选择HTTP方法,例如
GET、POST等。 - URL: 在地址栏中输入接口的URL。
- 发送: 点击“Send”按钮发送请求。
- 方法(Method): 在下拉菜单中选择HTTP方法,例如
- 查看结果: 请求发送后,你可以在下方窗口看到服务器返回的响应数据,包括状态码、响应体、响应头等。
理解常见的请求类型
1. GET请求
- 用途: 从服务器获取数据。
- 示例:
GET https://api.example.com/users - 参数设置: 如果有查询参数(query parameters),可以在URL中直接添加,或在“Params”标签页中输入键值对,Postman会自动帮你拼接到URL上。
2. POST请求
- 用途: 向服务器提交数据,例如创建新资源。
- 示例:
POST https://api.example.com/users - 参数设置:
- 切换到“Body”标签页。
- 选择数据类型,例如
raw(原始数据),然后选择JSON。 - 在文本框中输入JSON格式的请求体,例如:json
{ "name": "John Doe", "email": "john.doe@example.com" }请谨慎使用此类代码。
3. 其他请求
- PUT/PATCH: 用于更新服务器上的资源。
- DELETE: 用于删除服务器上的资源。
📊 核心区别速览表
| 方法 | 语义 | 安全性 | 幂等性 | 数据位置 | 典型用途 |
|---|---|---|---|---|---|
| GET | 获取资源 | ✅ 安全 | ✅ 幂等 | URL参数 | 查询、搜索、查看 |
| POST | 创建资源 | ❌ 不安全 | ❌ 不幂等 | 请求体 | 新增、提交、登录 |
| PUT | 更新/替换资源 | ❌ 不安全 | ✅ 幂等 | 请求体 | 完整更新资源 |
| DELETE | 删除资源 | ❌ 不安全 | ✅ 幂等 | URL参数 | 删除资源 |
🔍 深入理解核心概念
1. 安全性
- GET 是安全的:只读操作,不会改变服务器状态
- POST、PUT、DELETE 不安全:会改变服务器资源状态
2. 幂等性
- 幂等方法:多次执行效果与一次执行相同
- GET、PUT、DELETE 是幂等的:重复操作结果一致
- POST 不幂等:重复提交可能创建多个资源
💡 实际应用场景详解
GET - 数据检索
GET /api/users/123
GET /api/products?category=electronics
- 用途:获取用户信息、商品列表、搜索结果显示
- 特点:数据通过URL传递,可缓存,有长度限制(浏览器限制)
POST - 资源创建
POST /api/users
Body: {"name": "张三", "email": "zhang@example.com"}
- 用途:用户注册、发表评论、文件上传、下单购买
- 特点:数据在请求体中,无长度限制,适合大数据量传输
PUT - 完整更新
PUT /api/users/123
Body: {"name": "李四", "email": "li@example.com", "age": 25}
- 用途:更新用户完整信息、修改文章内容
- 特点:提供资源的完整表示来替换现有资源
DELETE - 资源删除
DELETE /api/users/123
DELETE /api/articles/456
- 用途:删除用户、移除商品、取消订单
- 特点:删除操作,需要谨慎使用
🎯 关键区别总结
1. GET vs POST
// GET - 参数在URL中
GET /api/search?q=keyword&page=1
// POST - 参数在请求体中
POST /api/login
Body: {username: "user", password: "pass"}
- 数据位置:GET在URL,POST在Body
- 安全性:GET参数可见,POST相对更安全
- 缓存:GET可缓存,POST一般不缓存
2. POST vs PUT
// POST - 创建新资源(ID由服务器生成)
POST /api/users
→ 返回:201 Created, Location: /api/users/100
// PUT - 更新指定资源(ID由客户端指定)
PUT /api/users/100
- URL语义:POST作用于集合,PUT作用于具体资源
- 幂等性:PUT是幂等的,POST不是
🔧 在Postman中的实践差异
GET 请求配置:
- 方法选择:GET
- 参数位置:Params标签页
- Body:通常为空
POST/PUT 请求配置:
- 方法选择:POST或PUT
- 参数位置:Body标签页
- Content-Type:需要指定(如application/json)
浅谈HTTP中Get、Post、Put与Delete的区别 - 龙-OSCAR - 博客园
GET,POST,PUT,DELETE的含义与区别 | 凡间的精灵
GET、POST、PUT、DELETE的区别 | 蒋先森のBlog
说说RESTFUL中的方法:GET、POST、PUT、PATCH、DELETE、OPTIONS、HEAD、TRACE | 冥加

Comments NOTHING