Coursera 笔记

Module 02 · Web API Essentials: REST API and GraphQL

Making API Requests using CURL and Postman使用 cURL 和 Postman 发出 API 请求

Coursera ↗

cURL:命令行数据传输工具

cURL 是 "Client URL" 的缩写,是一个命令行工具,支持通过各种网络协议进行数据传输。

核心特性与用途

  • 用途: cURL 用于与 Web 或应用程序服务器通信,通过指定相关 URL 和需要发送或接收的数据来实现。
  • 使用方式: 可以在命令行或脚本中使用 cURL 进行数据传输。
  • 常见协议: 支持包括 HTTP, HTTPS, FTP, 和 IMAP 等常见协议。
  • 常见用例:
    • 从互联网下载文件。
    • 端点测试(endpoint testing)。
    • 调试(debugging)。
    • 错误日志记录(error logging)。

cURL 命令解析

cURL 接受各种选项,使其成为一个极其通用的命令。选项以一个或两个破折号开头。

  • 示例命令:
    curl -X GET <URL> -H "Accept: application/json"
    
    选项 含义 示例解析
    -X 明确指定 HTTP 方法。 在示例中,指定使用 GET 方法。
    URL 要评估的 URL。 指定微服务的 URL。
    -H 允许您定义 Header(标头)。 在示例中,告诉 Web 服务器我们希望使用 JSON 格式。
  • 输出: 输出是产品微服务返回的产品列表,以 JSON 格式呈现。

Postman:API 平台

Postman 是一个 API 平台,用于构建和使用 API,它基于一系列用户友好的强大工具。

核心特性与优势

  • 目的: 帮助开发人员轻松地创建、测试、共享和文档化 API。
  • 简化 API 生命周期: Postman 通过编排多个请求,简化了 API 生命周期的每个步骤。这些请求可以重复或迭代执行。
  • 协作与效率: 帮助简化协作,以便更快地创建更优质的 API。
  • 易用性与流行度: 由于其简单性,它是测试各种 API 的最流行和方便的工具之一。
  • 协议支持: 支持多种协议,例如 HTTP 请求(如 GET, POST, PUT, PATCH)。
  • 代码生成: 可以将 API 转换为 JavaScript 和 Python 等语言的代码片段。
  • 提升开发体验: 流行示例:WhatsApp Business Platform Cloud API 使用 Postman 提供了简化的、开发者友好的体验,将入门时间缩短至几分钟。

使用 Postman 调用 API

  1. 开始新标签页: 在 Postman 中开始一个新的标签页。
  2. 设置请求类型: 将请求类型设置为 GET。
  3. 输入 URL: 输入您的微服务托管的 URL。
  4. 发送请求: 点击 "Send" 按钮以分析输出。
  5. 保存: 您可以将此请求保存在工作区中,以便将来再次调用您的 API。

总结

  • cURL 用于使用 URL 传输数据。
  • cURL 可以在命令行或脚本中使用。
  • Postman 是一个用于构建和使用 API 的平台。
  • Postman 是一个简单且流行的 API 测试工具。