学习太极创客 — ESP8226 （十）HTTP API 应用

通过浏览器搜索 API 可以搜索跟多 API 接口。

点击控制台， 点击免费版下面的免费申请。

这三个数据包括以下内容， 之后，点击产品管理中的免费版，出现下图。

说明：

心知天气 http API 说明文档链接： https://seniverse.yuque.com/books/share/e52aa43f-8fe9-4ffa-860d-96c0f3cf1c49/nyiu3t

上图中接口地址示例：https://api.seniverse.com/v3/weather/now.json?key=your_api_key&location=beijing&language=zh-Hans&unit=c

这个接口地址示例告诉我们，当我们向心知天气服务器请求时，我们应该模仿上述格式，而不是让我们点击的链接。

所以，在程序中，我们可以这样写，

const char* host = "api.seniverse.com";     // 将要连接的服务器地址  const int httpPort = 80;                    // 将要连接的服务器端口    // 心知天气HTTP请求所需信息 String reqUserKey = "xxxxxxxxx";   // 私钥 String reqLocation = "北京";            // 城市 String reqUnit = "c";                      // 摄氏/华氏  // 建立心知天气API当前天气请求资源地址 String reqRes = "/v3/weather/now.json?key="   reqUserKey                      "&location="   reqLocation                     "&language=en&unit="  reqUnit; 

还有就是，具体使用 POST 方法还是 GET 请求方法还取决于说明文档。一般来说，如果没有特别说明，则使用它 GET。

此外，

1、免费的 370 大部分城市都是国内地级城市，一般县级城市好。

如果没有访问权限(免费用户访问付费信息)，程序将返回 http 代码：403

2、位置 location 下面例子中的任何一个都可以使用指定。 比如，

String reqLocation = "xxxxxxxxx";            // 城市ID 

或

String reqLocation = "北京";            // 城市中文名 

或

String reqLocation = "Beijing";            // 城市英文名 

其它参数也可以类似指定。

当服务器收到我们发送的信息后，会给我们发送响应信息，响应信息格式内容及格式如下。 此时，如何分析以前学到的东西 JSON 句子的内容。(需要注意的是，免费版只能获取三种信息)

/********************************************************************** 项目名称/Project : 零基础入门学用物联网 程序名称/Program name : weather_now 团队/Team : 太极创客团队 / Taichi-Maker (www.taichi-maker.com) 作者/Author : CYNO朔 日期/Date（YYYYMMDD） : 20200602 程序目的/Purpose : 了解天气(www.seniverse.com)获取实时天气信息的免费服务。 ---------------------------------------------------------------------- 其它说明 / Other Description 心知天气API文档说明: https://www.seniverse.com/docs 本程序为太极创客团队制作的免费视频教程《零基础入门学用物联网 》中一部分。该教程系统的 向您讲述ESP8266的物联网应用相关的软件和硬件知识。以下是该教程目录页： http://www.taichi-maker.com/homepage/esp8266-nodemcu-iot/ ***********************************************************************/
#include <ArduinoJson.h>
#include <ESP8266WiFi.h>

const char* ssid     = "FAST_153C80";       // 连接WiFi名（此处使用taichi-maker为示例）
                                            // 请将您需要连接的WiFi名填入引号中
const char* password = "123456798";          // 连接WiFi密码（此处使用12345678为示例）
                                            // 请将您需要连接的WiFi密码填入引号中
 
const char* host = "api.seniverse.com";     // 将要连接的服务器地址 
const int httpPort = 80;                    // 将要连接的服务器端口 
 
// 心知天气HTTP请求所需信息
String reqUserKey = "xxxxxxxxx";   // 私钥
String reqLocation = "北京";            // 城市
String reqUnit = "c";                      // 摄氏/华氏
 
void setup(){ 
        
  Serial.begin(9600);          
  Serial.println("");
  
  // 连接WiFi
  connectWiFi();
}
 
void loop(){ 
        
  // 建立心知天气API当前天气请求资源地址
  String reqRes = "/v3/weather/now.json?key=" + reqUserKey +
                  + "&location=" + reqLocation + 
                  "&language=en&unit=" +reqUnit;
 
  // 向心知天气服务器服务器请求信息并对信息进行解析
  httpRequest(reqRes);
  delay(3000);
}
 
// 向心知天气服务器服务器请求信息并对信息进行解析
void httpRequest(String reqRes){ 
        
  WiFiClient client;
 
  // 建立http请求信息
  String httpRequest = String("GET ") + reqRes + " HTTP/1.1\r\n" + 
                              "Host: " + host + "\r\n" + 
                              "Connection: close\r\n\r\n";
  Serial.println(""); 
  Serial.print("Connecting to "); Serial.print(host);
 
  // 尝试连接服务器
  if (client.connect(host, 80)){ 
        
    Serial.println(" Success!");
 
    // 向服务器发送http请求信息
    client.print(httpRequest);
    Serial.println("Sending request: ");
    Serial.println(httpRequest);  
 
    // 获取并显示服务器响应状态行 
    String status_response = client.readStringUntil('\n');
    Serial.print("status_response: ");
    Serial.println(status_response);
 
    // 使用find跳过HTTP响应头
    if (client.find("\r\n\r\n")) { 
        
      Serial.println("Found Header End. Start Parsing.");
    }
    
    // 利用ArduinoJson库解析心知天气响应信息
    parseInfo(client); 
  } else { 
        
    Serial.println(" connection failed!");
  }   
  //断开客户端与服务器连接工作
  client.stop(); 
}
 
// 连接WiFi
void connectWiFi(){ 
        
  WiFi.begin(ssid, password);                  // 启动网络连接
  Serial.print("Connecting to ");              // 串口监视器输出网络连接信息
  Serial.print(ssid); Serial.println(" ...");  // 告知用户NodeMCU正在尝试WiFi连接
  
  int i = 0;                                   // 这一段程序语句用于检查WiFi是否连接成功
  while (WiFi.status() != WL_CONNECTED) { 
              // WiFi.status()函数的返回值是由NodeMCU的WiFi连接状态所决定的。 
    delay(1000);                               // 如果WiFi连接成功则返回值为WL_CONNECTED 
    Serial.print(i++); Serial.print(' ');      // 此处通过While循环让NodeMCU每隔一秒钟检查一次WiFi.status()函数返回值
  }                                            // 同时NodeMCU将通过串口监视器输出连接时长读秒。
                                               // 这个读秒是通过变量i每隔一秒自加1来实现的。 
  Serial.println("");                          // WiFi连接成功后
  Serial.println("Connection established!");   // NodeMCU将通过串口监视器输出"连接成功"信息。
  Serial.print("IP address: ");             // 同时还将输出NodeMCU的IP地址。这一功能是通过调用
  Serial.println(WiFi.localIP());              // WiFi.localIP()函数来实现的。该函数的返回值即NodeMCU的IP地址。 
}
 
// 利用ArduinoJson库解析心知天气响应信息
void parseInfo(WiFiClient client){ 
        
  const size_t capacity = JSON_ARRAY_SIZE(1) + JSON_OBJECT_SIZE(1) + 2*JSON_OBJECT_SIZE(3) + JSON_OBJECT_SIZE(6) + 230;
  DynamicJsonDocument doc(capacity);
  
  deserializeJson(doc, client);
  
  JsonObject results_0 = doc["results"][0];
  
  JsonObject results_0_now = results_0["now"];
  const char* results_0_now_text = results_0_now["text"]; // "Sunny"
  const char* results_0_now_code = results_0_now["code"]; // "0"
  const char* results_0_now_temperature = results_0_now["temperature"]; // "32"
  
  const char* results_0_last_update = results_0["last_update"]; // "2020-06-02T14:40:00+08:00" 
 
  // 通过串口监视器显示以上信息
  String results_0_now_text_str = results_0_now["text"].as<String>(); 
  int results_0_now_code_int = results_0_now["code"].as<int>(); 
  int results_0_now_temperature_int = results_0_now["temperature"].as<int>(); 
  
  String results_0_last_update_str = results_0["last_update"].as<String>();   
 
  Serial.println(F("======Weahter Now======="));
  Serial.print(F("Weather Now: "));
  Serial.print(results_0_now_text_str);
  Serial.print(F(" "));
  Serial.println(results_0_now_code_int);
  Serial.print(F("Temperature: "));
  Serial.println(results_0_now_temperature_int);
  Serial.print(F("Last Update: "));
  Serial.println(results_0_last_update_str);
  Serial.println(F("========================"));
}

运行结果如下， 如果要显示为中文，也很好办。只需要将上述代码中的 language 换成 zh-Hans 即可。

  // 建立心知天气API当前天气请求资源地址
  String reqRes = "/v3/weather/now.json?key=" + reqUserKey +
                  + "&location=" + reqLocation + 
                  "&language=zh-Hans&unit=" +reqUnit;

心知天气 API 使用手册链接: https://seniverse.yuque.com/books/share/e52aa43f-8fe9-4ffa-860d-96c0f3cf1c49/sl6gvt 免费权限只可以获取未来三天（今、明、后）的天气预报 看下北京今天和未来 2 天的预报的接口示例。

https://api.seniverse.com/v3/weather/daily.json?key=your_api_key&location=beijing&language=zh-Hans&unit=c&start=0&days=3

上面，0 代表从今天开始，一共给我 3 天的天气信息。

因此，在代码中，我们在代码中的请求信息就可以这样写，

const char* host = "api.seniverse.com";     // 将要连接的服务器地址 
const int httpPort = 80;                    // 将要连接的服务器端口 
 
// 心知天气HTTP请求所需信息
String reqUserKey = "xxxxxxxxx";   // 私钥
String reqLocation = "徐州";            // 城市
String reqUnit = "c";                     // 摄氏/华氏

void loop(){ 
        
  // 建立心知天气API当前天气请求资源地址
  String reqRes = "/v3/weather/daily.json?key=" + reqUserKey +
                  + "&location=" + reqLocation + 
                  "&language=zh-Hans&unit=" + reqUnit + 
                  "&start=0&days=5";

之后，通过 readString 函数 和 串口可打印服务器给我们响应的信息。

String serverJson = client.readString();
Serial.println(serverJson);

下面是请求和响应：

请求：GET /v3/weather/daily.json?key=SfTuErWQYniaWXlZw&location=徐州&language=zh-Hans&unit=c&start=0&days=5 HTTP/1.1

响应：{ 
        "results":[{ 
        "location":{ 
        "id":"WW56FQXV5ZHB","name":"徐州","country":"CN","path":"徐州,徐州,江苏,中国","timezone":"Asia/Shanghai","timezone_offset":"+08:00"},"daily":[{ 
        "date":"2022-06-22","text_day":"多云","code_day":"4","text_night":"多云","code_night":"4","high":"36","low":"28","rainfall":"0.00","precip":"0.00","wind_direction":"南","wind_direction_degree":"180","wind_speed":"8.4","wind_scale":"2","humidity":"67"},{ 
        "date":"2022-06-23","text_day":"大雨","code_day":"15","text_night":"多云","code_night":"4","high":"32","low":"26","rainfall":"17.17","precip":"0.99","wind_direction":"西","wind_direction_degree":"270","wind_speed":"8.4","wind_scale":"2","humidity":"84"},{ 
        "date":"2022-06-24","text_day":"多云","code_day":"4","text_night":"多云","code_night":"4","high":"36","low":"28","rainfall":"0.00","precip":"0.00","wind_direction":"西南","wind_direction_degree":"225","wind_speed":"3.0","wind_scale":"1","humidity":"78"}],"last_update":"2022-06-22T08:00:00+08:00"}]}

为了观察方便，利用 JSON 格式化工具（ https://www.oktools.net/）可进行查看（通过串口复制可利用阅读）。 由此，我们就获取到了心知天气发给我们的响应信息了，下面就是利用 ArduinoJson 库解析心知天气响应信息。

这里使用在线的 JSON 工具进行生成，生成后的代码如下。

// Stream& input;

DynamicJsonDocument doc(1536);

DeserializationError error = deserializeJson(doc, input);

if (error) { 
        
  Serial.print(F("deserializeJson() failed: "));
  Serial.println(error.f_str());
  return;
}

JsonObject results_0 = doc["results"][0];

JsonObject results_0_location = results_0["location"];
const char* results_0_location_id = results_0_location["id"]; // "WW56FQXV5ZHB"
const char* results_0_location_name = results_0_location["name"]; // "徐州"
const char* results_0_location_country = results_0_location["country"]; // "CN"
const char* results_0_location_path = results_0_location["path"]; // "徐州,徐州,江苏,中国"
const char* results_0_location_timezone = results_0_location["timezone"]; // "Asia/Shanghai"
const char* results_0_location_timezone_offset = results_0_location["timezone_offset"]; // "+08:00"

for (JsonObject results_0_daily_item : results_0["daily"].as<JsonArray>()) { 
        

  const char* results_0_daily_item_date = results_0_daily_item["date"]; // "2022-06-22", "2022-06-23", ...
  const char* results_0_daily_item_text_day = results_0_daily_item["text_day"]; // "多云", "大雨", "多云"
  const char* results_0_daily_item_code_day = results_0_daily_item["code_day"]; // "4", "15", "4"
  const char* results_0_daily_item_text_night = results_0_daily_item["text_night"]; // "多云", "多云", "多云"
  const char* results_0_daily_item_code_night = results_0_daily_item["code_night"]; // "4", "4", "4"
  const char* results_0_daily_item_high = results_0_daily_item["high"]; // "36", "32", "36"
  const char* results_0_daily_item_low = results_0_daily_item["low"]; // "28", "26", "28"
  const char* results_0_daily_item_rainfall = results_0_daily_item["rainfall"]; // "0.00", "17.17", "0.00"
  const char* results_0_daily_item_precip = results_0_daily_item["precip"]; // "0.00", "0.99", "0.00"
  const char* results_0_daily_item_wind_direction = results_0_daily_item["wind_direction"]; // "南", "西", ...
  const char* results_0_daily_item_wind_direction_degree = results_0_daily_item["wind_direction_degree"];
  const char* results_0_daily_item_wind_speed = results_0_daily_item["wind_speed"]; // "8.4", "8.4", "3.0"
  const char* results_0_daily_item_wind_scale = results_0_daily_item["wind_scale"]; // "2", "2", "1"
  const char* results_0_daily_item_humidity = results_0_daily_item["humidity"]; // "67", "84", "78"

}

const char* results_0_last_update = results_0["last_update"]; // "2022-06-22T08:00:00+08:00"

将上述代码拷贝到自己的程序中，然后进行修改。

由于没有系统的学习过 JSON 的语法，所以对于这里 for 循环的处理有些不知所措，到最后，还是老老实实的模仿演示程序中的方式去书写。（以后遇到类似情况，也可以继续模仿该程序去写。）

最后，修改后的整体程序代码如下，

/********************************************************************** 项目名称/Project : 零基础入门学用物联网 程序名称/Program name : weather_now 团队/Team : 太极创客团队 / Taichi-Maker (www.taichi-maker.com) 作者/Author : CYNO朔 日期/Date（YYYYMMDD） : 20200602 程序目的/Purpose : 通过心知天气(www.seniverse.com)免费服务获取实时天气信息。 ----------------------------------------------------------------------- 其它说明 / Other Description 心知天气API文档说明: https://www.seniverse.com/docs 本程序为太极创客团队制作的免费视频教程《零基础入门学用物联网 》中一部分。该教程系统的 向您讲述ESP8266的物联网应用相关的软件和硬件知识。以下是该教程目录页： http://www.taichi-maker.com/homepage/esp8266-nodemcu-iot/ ***********************************************************************/
#include <ArduinoJson.h>
#include <ESP8266WiFi.h>

const char* ssid     = "FAST_153C80";       // 连接WiFi名（此处使用taichi-maker为示例）
                                            // 请将您需要连接的WiFi名填入引号中
const char* password = "123456798";          // 连接WiFi密码（此处使用12345678为示例）
                                            // 请将您需要连接的WiFi密码填入引号中
 
const char* host = "api.seniverse.com";     // 将要连接的服务器地址 
const int httpPort = 80;                    // 将要连接的服务器端口 
 
// 心知天气HTTP请求所需信息
String reqUserKey = "SfTuErWQYniaWXlZw";   // 私钥
String reqLocation = "徐州";            // 城市
String reqUnit = "c";                      // 摄氏/华氏
 
void setup(){ 
        
  Serial.begin(9600);          
  Serial.println("");
  
  // 连接WiFi
  connectWiFi();
}
 
void loop(){ 
        
  // 建立心知天气API当前天气请求资源地址
  String reqRes = "/v3/weather/daily.json?key=" + reqUserKey +