A03_一个简单的接口案例说明

A03_一个简单的接口案例说明

一. 被测接口说明

学习接口测试就要有实际接口的案例,这里我们使用 pm25.in 站点提供的用于学习和测试的公开接口,通过对接口的访问,可以实时获取 PM 2.5 的空气质量数据。

接口说明官网地址:http://www.pm25.in/api_doc

接口的主要功能

1. pm25.in 是免费提供空气质量数据的一个公益性网站,其数据全部来源于网友提供的国家环保网站公开数据。

2. 该接口接收 HTTP 请求,响应 JSON 格式数据。

3. 目前不提供历史数据,只提供最近一小时的数据。

4. 初学者、用于测试者可以使用公共测试 AppKey(AppKey = 5j1znBVAsnSf5xQyNQyq)。

5. 该公共 AppKey 用于测试和学习,每小时有访问次数的限制。

接口详细描述

请求地址:http://www.pm25.in/api/querys/pm2_5.json

请求方法:GET

请求参数:

  • city:城市名称(必选参数),可以使用中文城市名称,如“珠海”,也可以使用拼音,如“zhuhai”
  • token:AppKey(此处我们使用公开的)

返 回 值:一个JSON数组,里面的每一项对应一个监测点的PM2.5信息

请求示例:

  • http://www.pm25.in/api/querys/pm2_5.json?city=珠海&token=xxxxxx
  • http://www.pm25.in/api/querys/pm2_5.json?city=zhuhai&token=xxxxxx

请求成功返回数据格式如下:

[
    {
        "aqi": 82,
        "area": "珠海",
        "pm2_5": 31,
        "pm2_5_24h": 60,
        "position_name": "吉大",
        "primary_pollutant": "颗粒物(PM2.5)",
        "quality": "良",
        ..................
    },
    .....
]

请求失败返回错误信息,如下:

{ "error": "参数不能为空" }
{ "error": "该城市还未有PM2.5数据" }
{ "error": "Sorry,您这个小时内的API请求次数用完了,休息一下吧!" }
{ "error": "You need to sign in or sign up before continuing." }

补充知识:关于 AppKey

1. 公司的接口一般是不会随意暴露到公众视线的,这里涉及数据和安全等多方面的因素,所以接口的访问就要设置身份认证和相关权限了,该网站要求在请求 pm2.5 接口数据的时候,必须附带一个 AppKey 用于你身份的认证。

2. 目前该网站提供了一个公开用于测试的 Appkey,所有人都可以使用,但是每小时内有访问次数的限制。

3. 如果想拥有自己独立的 AppKey,则可以在官网页面自行申请。

发布了30 篇原创文章 · 获赞 0 · 访问量 248

猜你喜欢

转载自blog.csdn.net/weixin_42007999/article/details/105580202