教程 ky tutorial

安装与配置

本章节介绍如何在项目中安装 Ky,并进行全局配置或创建实例,以便在项目中统一管理请求设置。

安装

使用 npm 或 yarn 安装 Ky:

bash
# 使用 npm
npm install ky

# 使用 yarn
yarn add ky

`

如果你使用的是浏览器直接引入,也可以通过 CDN:

html
<script type="module">
  import ky from 'https://cdn.skypack.dev/ky';
</script>

基本配置

Ky 提供全局配置和实例配置两种方式。

1. 全局默认配置

你可以在每次请求中传递选项,也可以通过创建实例统一管理:

javascript
import ky from 'ky';

const api = ky.create({
  prefixUrl: 'https://api.example.com',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN'
  },
  timeout: 5000,
  retry: 2
});

async function getUser() {
  const data = await api.get('user').json();
  console.log(data);
}

getUser();

2. 单次请求配置

每次请求都可以单独设置:

javascript
import ky from 'ky';

async function fetchData() {
  const data = await ky.get('https://api.example.com/data', {
    headers: {
      'X-Custom-Header': 'value'
    },
    timeout: 3000
  }).json();

  console.log(data);
}

fetchData();

小结

  • Ky 可以通过 npm/yarn 或 CDN 安装。
  • 支持全局实例配置和单次请求配置。
  • 可统一管理前缀 URL、请求头、超时和重试策略。