plz.el 使用教程

plz.el 使用教程

plz.el An HTTP library for Emacs 项目地址: https://gitcode.com/gh_mirrors/pl/plz.el

1. 项目介绍

plz.el 是一个为 Emacs 编辑器设计的 HTTP 请求库。它使用 curl 作为后端，这避免了使用 Emacs 内置的 url 库可能遇到的一些问题。plz.el 支持同步和异步请求，其 API 设计简洁、自然且富有表现力。代码旨在保持简单和良好的组织结构，并且每一个功能都经过针对 httpbin 的测试。

2. 项目快速启动

首先，确保你的系统中安装了 curl。然后，可以通过以下两种方式安装 plz.el：

通过 GNU ELPA 安装

在 Emacs 中使用 package-install 命令安装 plz.el。

手动安装

将 plz.el 文件放置到你的 load-path 目录中，并在 Emacs 中执行 (require 'plz)。

下面是一个快速启动的示例代码，演示如何使用 plz.el 发起一个 GET 请求并获取响应：

(plz 'get "https://httpbin.org/user-agent")

这将返回类似以下内容：

{
  "user-agent": "curl/7.35.0"
}

3. 应用案例和最佳实践

下面是一些使用 plz.el 的案例和最佳实践。

同步 GET 请求

获取一个 URL 的响应体并返回解码后的字符串（例如，原始 JSON）：

(plz 'get "https://httpbin.org/user-agent" :as 'string)

异步 POST 请求

发送一个 JSON 对象作为请求体，然后解析响应体中的 JSON 对象，并使用一个函数处理结果：

(plz 'post "https://httpbin.org/post"
      :headers '(("Content-Type" . "application/json"))
      :body (json-encode '(("key" . "value")))
      :as 'json-read
      :then (lambda (alist) (message "Result: %s" (alist-get 'data alist))))

下载并创建图像

同步下载一个 JPEG 文件，然后从数据中创建一个 Emacs 图像对象：

(let ((jpeg-data (plz 'get "https://httpbin.org/image/jpeg" :as 'binary)))
  (create-image jpeg-data nil 'data))

4. 典型生态项目

plz.el 作为 Emacs 中的一个 HTTP 库，可以与许多其他 Emacs 包和工具集成，例如：

• emacs-http.el：另一个 Emacs 中的 HTTP 客户端库。
• request.el：一个用于发起 HTTP 请求的 Emacs 库。
• json.el：用于处理 JSON 数据的 Emacs 库。

这些工具和 plz.el 一起，构成了一个强大的 Emacs HTTP 请求和处理生态系统。

plz.el An HTTP library for Emacs 项目地址: https://gitcode.com/gh_mirrors/pl/plz.el