好多没看技术了,今天整理下PostMan的基础功能的用法。希望能踩个狗屎运,过个顺当的人生。
概述
1. 使用Postman,需要一个有效的API键向API终点发送请求,这个键直可以从集成板栗找到。
2. API有一个适合于它的访问比率限制。
3. PostMan API只对给予HTTP的安全沟通响应。HTTP请求会发送一个301重定向到相应的HTTPS资源。
3. 每个请求的响应都是通过JSON格式发送的。如果API请求出现错误,会以"error"{}键值的形式呈现在JSON响应。
5. 请求方法(是个动词)决定你想要操作的动作属性。使用GET方法的请求暗示你想从PostMan哪里获取一些东西,而POST方法则暗示你想要保存一些新的东西到Postman。
5. API调用会用合适的HTTP状态吗来响应所有的请求。在Postman客户端内部,当接收到一个响应时,状态吗会以高亮的形式显示,并伴有一个帮助文本来标明响应代码的含义。200OK状态吗表示一切运行良好,而4XX或5XX响应码表示请求客户端有错误或者API服务器端有错误。
7. PostMan账户的个人资源使用唯一的id(uid)来访问。uid是资源拥有着的用户id和资源id的简单串联符号。举个栗子,一个集合的uid是{{owner_id}}-{{collection_id}}.
验证
一个PostmanAPI请求的发送必须包括一个API键,格式是有一个X-Api-Key请求头。
如果你没有API键,可以通过找到Postman 集成板来生成一个。
API 键告诉API 服务器它接收到的请求是你发送的。你能访问的Postman的所有东西都是通过你产生的API键来获得访问的。
为了方便使用Postman,你可以将API键保存到一个环境变量postman_api_key中,这个集合会自动使用它来进行一次API调用。
API键相关的错误响应
如果API键遗失,格式破坏,或失效,你将收到一个401未授权响应码和一下的JSON响应:
{
"error": {
"name": "AuthenticationError",
"message": "API Key missing. Every request requires an API Key to be sent."
}
}
使用API键作为查询参数
每个请求接收API键为X-Api-Key请求头,也可称为apikey URL查询参数。
API键作为头文件的一部分在你同时使用请求头和查询参数来发送键的时候具有更高的优先级。
速率限制
API 访问速率限制用单位时间的键数来表示。使用键访问API的速率被限制为每分钟60个请求。另外,每个API响应伴随有以下头文件来识别你的资源消耗的状态。
Header | Description |
X-RateLimit-Limit | 消费者能被允许的每分钟可以发送的最大请求数。 |
X-RateLimit-Remaining | 当前速率限制窗口下遗留的请求数。 |
X-RateLimit-Reset | 当前速率限制窗口重新设置的UTC时间秒。 |
当你点击速率限制按钮,你将会接收到一个类似于如下JSON格式的响应,状态吗为429 Too Many Request.
{
"error": {
"name": "rateLimitError",
"message": "Rate Limit exceeded. Please retry at 1465452702843"
}
}
支持和具体使用
有关于如何访问PostmanAPI,请查看官方文档。
官方使用手册 https://www.getpostman.com/licenses/privacy
以下是API参考方法
1. Collections[集合]
GET 所有的集合
/collections端点返回一个所有的collections集合可以访问。这个集合包括你自己的collections和你订阅的collections.
响应包含一个collection信息数组,collection信息包含name,id,owner和uid信息。
需要API Key作为X-Api-Key请求头或apikey URL查询参数。
头文件 HEADERS
X-Api-Key
{{postman_api_key}}
举例:
有效的响应
curl --location --request GET "https://api.getpostman.com/collections"\
--header "X-Api-Key: {{postman_api_key}}"
200 - OK
{
"collections": [
{
"id": "dac5eac9-148d-a32e-b76b-3edee9da28f7",
"name": "Cloud API",
"owner": "552213",
"uid": "552213-dac5eac9-148d-a32e-b76b-3edee9da28f7"
},
{
"id": "d223sw-daew2-deo9-ojoiej89-20dewds1423003",
"name": "Postman Echo",
"owner": "552213",
"uid": "552213-d223sw-daew2-deo9-ojoiej89-20dewds1423003"
}
]
}
POST 创建集合collection:
https://api.getpostman.com/collections
这个断点允许你使用Postman Collection V2格式来创建集合。
成功创建集合后,响应会返回一个集合的name,id,和uid.
也可以指定工作空间的内容通过传递workspace作为查询参数来创建一个集合。
需要API Key作为X-Api-Key请求头或apikey URL查询参数。
头文件HEADERS
X-Api-Key: {{postman_api_key}}
Content-Type: {{postman_api_key}}
主体部分BODY:
{
"collection": {
"info": {
"name": "Sample Collection 132",
"description": "This is just a sample collection.",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
"name": "This is a folder",
"item": [ { "name": "Sample POST Request","request": { "url": "https://postman-echo.com/post", "method": "POST", "header": [ { "key": "Content-Type","value": "application/json" } ],
"body": { "mode": "raw", "raw": "{\"data\":\"123\"} },
"description": "This is a sample POST Request"
} } ] },
{ "name": "Sample GET Request", "request": {"url":"https://postman-echo/get",
"method":"GET",
"description":"This is a smaple GET Request"
} } ] }}
响应示例
200 -OK
{"collection": {
"id":"24125d7e-1e5s-492b-adfe-938009cd402e",
"name":"Sample Collection",
"uid": "5552-24125d7e-1e5s-492b-adfe-938009cd402e"
} }
第一篇到此。