
在使用第三方API时,特别是涉及大量数据检索的场景,API通常会采用分页(Pagination)机制来管理和限制单次请求返回的数据量。这种机制有几个主要目的:
对于USDA Food Data Central (FDC) API,默认情况下,其搜索接口(/foods/search)每次请求最多返回50条结果。如果未正确处理分页,用户将只能获取到数据集的冰山一角。
要正确处理API分页,首先需要识别API响应中包含的分页信息。通常,API会在响应体中提供当前页码、总页数以及每页大小等关键信息。以USDA FDC API为例,当您发起一个搜索请求并获取到JSON响应时,会发现类似currentPage和totalPages这样的字段,它们明确指示了结果是分页的,并且提供了遍历所有页面所需的信息。
此外,查阅API官方文档是理解分页机制最直接有效的方式。USDA FDC API的文档会明确指出哪些参数用于控制分页,例如pageSize(每页返回结果数量)和pageNumber(请求的页码)。根据文档,pageSize的默认值是50,但最大可以设置为200。
要获取所有符合条件的数据,我们需要实施一个迭代请求策略,即:
以下是一个使用Python requests库实现USDA FDC API分页数据检索的示例:
import requests
import json
import pandas as pd
def get_all_food_data(query_term: str, api_key: str, max_page_size: int = 200) -> list:
"""
通过迭代请求USDA FDC API,获取指定查询词的所有食物营养数据。
Args:
query_term (str): 搜索的食物名称或关键词。
api_key (str): 您的USDA FDC API密钥。
max_page_size (int): 每页请求的最大结果数量,USDA FDC API最大支持200。
Returns:
list: 包含所有食物营养数据的列表,每个元素是一个字典。
如果请求失败或无数据,则返回空列表。
"""
all_foods = []
# 构建基础URL,设置API密钥和查询词,并指定最大页大小
base_url = f"https://api.nal.usda.gov/fdc/v1/foods/search?api_key={api_key}&query={query_term}&pageSize={max_page_size}"
with requests.Session() as session: # 使用requests.Session保持连接,提高效率
try:
# 1. 获取第一页数据,并确定总页数
print(f"Fetching page 1 for query: '{query_term}'...")
response = session.get(base_url, timeout=15)
response.raise_for_status() # 检查HTTP请求是否成功
api_response = response.json()
if not api_response.get("foods"):
print(f"No foods found for query: '{query_term}'.")
return []
all_foods.extend(api_response["foods"])
total_pages = api_response.get("totalPages", 1)
print(f"Total pages to retrieve: {total_pages}")
# 2. 迭代获取后续页面数据
for page_num in range(2, total_pages + 1):
print(f"Fetching page {page_num}...")
page_url = f"{base_url}&pageNumber={page_num}"
page_response = session.get(page_url, timeout=15)
page_response.raise_for_status()
page_data = page_response.json()
all_foods.extend(page_data["foods"])
except requests.exceptions.HTTPError as http_err:
print(f"HTTP error occurred: {http_err} - Status Code: {response.status_code}")
return []
except requests.exceptions.ConnectionError as conn_err:
print(f"Connection error occurred: {conn_err}")
return []
except requests.exceptions.Timeout as timeout_err:
print(f"Timeout error occurred: {timeout_err}")
return []
except requests.exceptions.RequestException as req_err:
print(f"An unexpected error occurred: {req_err}")
return []
except json.JSONDecodeError:
print(f"Failed to decode JSON from response: {response.text[:200]}...")
return []
return all_foods
# --- 示例使用 ---
if __name__ == "__main__":
# 请替换为您的实际API密钥
YOUR_API_KEY = "YOUR_USDA_API_KEY"
search_query = "raw" # 例如,搜索所有“生”的食物
# 1. 获取所有食物数据
food_items = get_all_food_data(search_query, YOUR_API_KEY)
if food_items:
print(f"\nSuccessfully retrieved {len(food_items)} food items.")
# 2. 将获取到的数据转换为DataFrame并进行处理
table_data = []
for food_item in food_items:
row = {
"Description": food_item.get("description", "N/A"),
"FDC_ID": food_item.get("fdcId", "N/A")
}
# 提取主要营养素
for nutrient in food_item.get("foodNutrients", []):
nutrient_name = nutrient.get("nutrientName")
if nutrient_name:
row[nutrient_name] = nutrient.get("value")
table_data.append(row)
df = pd.DataFrame(table_data)
# 3. 数据清洗和处理(示例)
# 移除完全为空的列(如果有很多稀疏营养素)
df.dropna(axis=1, how='all', inplace=True)
# 填充NaN值,例如用0或平均值
df.fillna(0, inplace=True)
print("\nDataFrame Head:")
print(df.head())
print(f"\nDataFrame Shape: {df.shape}")
# 4. 导出到Excel
try:
output_filename = f'{search_query}_food_data.xlsx'
df.to_excel(output_filename, index=False)
print(f"\nData successfully exported to '{output_filename}'")
except Exception as e:
print(f"Error exporting to Excel: {e}")
else:
print("No data to process or export.")
通过本文的详细讲解和示例代码,您应该已经掌握了如何有效地处理USDA FDC API的分页问题,从而获取完整的营养数据。核心在于理解API的分页机制,利用pageSize和pageNumber参数,并结合迭代请求和健壮的错误处理机制。这种方法不仅适用于USDA FDC API,也适用于大多数采用分页策略的RESTful API。在实际开发中,始终优先查阅API官方文档,它是解决此类问题的最佳指南。
以上就是深入理解与实现USDA FDC API数据分页获取的详细内容,更多请关注php中文网其它相关文章!
每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。
Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号