前言
随着国际化需求的不断增加，前端项目中常常会用到翻译 API。onesky-fetch 是一款 npm 包，能够帮助前端快速调用 OneSky 翻译 API 实现国际化功能。本文将详细介绍 onesky-fetch 的使用方法。
onesky-fetch 简介
onesky-fetch 是一个基于 fetch 封装的 OneSky API 客户端。可以用于前后端分离的项目，使用时只需在前端按照规范进行配置即可。
配置方法
- 安装 onesky-fetch
可以通过 npm 或者 yarn 安装 onesky-fetch，安装命令如下：
npm install onesky-fetch
或
yarn add onesky-fetch
- 引入 onesky-fetch
引入 onesky-fetch 的方式有两种，一种是在入口文件中引入：
import oneskyFetch from 'onesky-fetch';
另一种是在其他需要使用的文件中引入：
const oneskyFetch = require('onesky-fetch');- 配置 onesky-fetch
在使用 onesky-fetch 之前，需要进行配置。配置信息包括以下内容：
- domain: OneSky API 域名
- apiKey: OneSky API key
- apiSecret: OneSky API secret
- projectId: OneSky 项目 ID
- sourceFilePath: 本地的资源文件路径
- exportFilePath: 从 OneSky 导出的资源文件路径
配置方式如下：
oneskyFetch.config({
domain: 'https://platform.api.onesky.io/1',
apiKey: 'your_api_key',
apiSecret: 'your_api_secret',
projectId: 'your_project_id',
sourceFilePath: 'your_local_resource_path',
exportFilePath: 'your_onesky_export_path',
});- 使用 onesky-fetch
onesky-fetch 目前有以下几个方法：
- uploadFile: 上传翻译文件
- exportFile: 导出翻译文件
- importTranslation: 导入翻译
- deleteTranslation: 删除翻译
使用方法示例：
-- -------------------- ---- ------- -- ------ ---------------------------------------- -- - ---------------------- --- -- ------ ---------------------------------------- -- - ---------------------- --- -- ---- ----------------------------------------------- -- - ---------------------- --- -- ---- ----------------------------------------------- -- - ---------------------- ---
通过 oneskyFetch.uploadFile() 方法上传翻译文件，可以在 OneSky 后台获取设定的语言版本的翻译文件，使用 importTranslation 方法导入翻译文件，使用 exportFile 方法获取最新版本的翻译文件，在本地使用。
总结
通过本篇文章，我们了解了如何使用 npm 包 onesky-fetch 实现国际化的功能。不仅如此，onesky-fetch 也可以帮助前端处理一些本地化的问题，提升开发效率。希望对大家有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600556a281e8991b448d36be