Roy

一个用于消费RESTful API的高级库。

目录

• Roy
  • 目录
  • 文档
  • 安装
  • 使用
    • GET
    • POST
    • PATCH
    • PUT
    • DELETE
  • 许可证
  • 名字背后的故事

文档

• API参考

安装

将以下内容添加到您的Cargo.toml

[dependencies]
roy = "0.1"

使用

要使用roy::Client结构体上的任何方法，它必须实例化如下

// import into scope
use roy::Client;
// Instantiate `Client` with your API's base URL
let c = roy::Client::new("https://httpbin.org".to_string());  

以下所有示例都假定结构体已经被实例化。

快速入门

roy提供了一个高级的request函数，可用于快速发送请求。要发送

GET

c.get("/get", false); // Make a GET request to your endpoint

或

c.request("/get", roy::RequestMethod::GET, None); // Make GET request using alternate `request` function

POST

c.post("/post", "{some: data}"); // Make a POST request to your endpoint

或

c.request("/post", roy::RequestMethod::POST, Some("{}")); // Make POST request using alternate `request` function

PATCH

c.patch("/patch", "{some: data}"); // Make a PATCH request to your endpoint

或

c.request("/patch", roy::RequestMethod::PATCH, Some("{}")); // Make PATCH request using alternate `request` function

PUT

c.put("/put", "{some: data}"); // Make a PUT request to your endpoint

或

c.request("/put", roy::RequestMethod::PUT, Some("{}")); // Make PUT request using alternate `request` function

DELETE

c.delete("/delete"); // Make a DELETE request to your endpoint

或

c.request("/delete", roy::RequestMethod::DELETE, None); // Make DELETE request using alternate `request` function

许可证

Roy在MIT许可证和Apache许可证（版本2.0）的条款下分发。

请参阅LICENSE-APACHE、LICENSE-MIT和COPYRIGHT以获取详细信息。

名字背后的故事

此crate以Roy Fielding命名，他定义了表征状态转移。

Roy Fielding在加州大学欧文分校2000年的博士论文《架构风格和网络软件架构设计》中定义了REST。他在1996-1999年与HTTP 1.1并行开发REST架构风格，基于1996年的HTTP 1.0现有设计。