unrested：极简且类型安全的REST客户端

unrested：极简且类型安全的REST客户端

unrested 🚥 Minimal, type-safe REST client using JS proxies (36 loc) 项目地址: https://gitcode.com/gh_mirrors/un/unrested

项目介绍

unrested 是一个轻量级的 REST 客户端，利用 JavaScript 代理来实现类型安全的 HTTP 请求。它提供了简洁的语法，使得开发者能够以更直观、更高效的方式构建网络请求。此项目已被集成到 apiful 中，虽然 unrested 仍可使用，但将不再进行积极维护。对于寻求更丰富特性的用户，建议迁移至 apiful。

项目技术分析

unrested 的核心是利用 JavaScript 的代理（Proxies）功能，提供类型安全的接口访问。它通过链式调用和括号语法的支持，使得代码不仅易于编写，也易于阅读和维护。在底层，unrested 使用了 ofetch 库来处理数据获取，继承了 ofetch 的所有选项和配置。

技术特点

• 轻量级：代码仅 36 行，不引入额外的依赖。
• 类型安全：利用 TypeScript 提供类型安全的接口。
• 链式和括号语法：支持链式调用，如 api.nested.users(1).get()，也支持括号语法，如 api.nested.users["1"].get()。
• HTTP 方法支持：支持包括 .post() 在内的多种 HTTP 方法。

项目及技术应用场景

unrested 的设计使其非常适合以下场景：

1. 类型安全的网络请求：在 TypeScript 项目中，确保网络请求的类型正确性。
2. RESTful API 的交互：提供简洁的语法来处理 API 的交互，减少样板代码。
3. 轻量级客户端需求：适用于对网络请求处理要求较高的场景，尤其是需要保持客户端体积最小的项目。

使用示例

import { createClient } from 'unrested'

// 创建客户端，可以指定基础URL
const api = createClient({
  baseURL: 'https://jsonplaceholder.typicode.com',
})

// 发起 GET 请求
const response = await api.users.get<UserResponse>()

// 发起 POST 请求
const postResponse = await api.users.post({ name: 'foo' })

项目特点

1. 简洁易用：unrested 以其简洁的 API 设计著称，使得网络请求的构建变得极其简单。
2. 类型安全：通过 TypeScript 的类型系统，确保请求和响应的类型正确性。
3. 灵活配置：支持所有 ofetch 的选项，使得用户可以根据需求灵活配置请求。
4. 链式调用：支持链式和括号语法，使得代码更具可读性和维护性。

如何安装

可以通过以下命令将 unrested 添加到您的项目中：

# npm
npm install unrested

# pnpm
pnpm add unrested

# yarn
yarn add unrested

总结

unrested 以其极简和类型安全的特点，在处理 RESTful API 交互时提供了一个高效、直观的方式。对于开发者而言，它不仅提高了开发效率，还通过类型检查增强了代码的健壮性。尽管 unrested 将不再维护，但其精神继承者 apiful 提供了更多特性，值得开发者关注和尝试。

unrested 🚥 Minimal, type-safe REST client using JS proxies (36 loc) 项目地址: https://gitcode.com/gh_mirrors/un/unrested