在前端开发中，如果需要访问后台接口的数据，经常要用到 SDK。而 SDK 的生成过程是比较繁琐的，需要手动对接口进行定义、编写代码、进行打包等操作。因此，现在有一种神器——@mean-expert/loopback-sdk-builder，可以让我们轻松愉快地生成 SDK。
@mean-expert/loopback-sdk-builder 简介
@mean-expert/loopback-sdk-builder 是针对 LoopBack 框架的 SDK 生成工具，可以将 LoopBack 应用程序的 RESTful API 转换为可重用、可扩展和类型定义的 SDK。其主要特点如下：
- 支持 TypeScript 和 JavaScript 两种语言。
- 可以根据后端 API 在前端自动生成 API 方法，大大简化了 SDK 的调用过程。
- 支持多种自定义配置，例如自定义 API 前缀、请求头、特定的服务提供者等。
- 生成的 SDK 可以直接打包成 npm 包，方便其他项目的调用。
SDK 生成步骤
第一步：安装 @mean-expert/loopback-sdk-builder
$ npm install -g @mean-expert/loopback-sdk-builder
安装完毕后，您可以通过执行 lb-sdk 命令行来创建应用程序的 SDK。
第二步：生成 LoopBack 应用程序的 API 文档
$ npm install -g apiconnect $ apic loopback
然后，根据提示生成相应的 LoopBack 应用程序。
接着，用以下命令生成 API 文档：
$ cd my-loopback-app $ apic edit
第三步：生成 SDK
- 在 SDK 生成目录中创建 SDK 目录：
$ mkdir sdk $ cd sdk
- 通过以下命令生成 SDK，其中
http://localhost:3000是您的 LoopBack 应用程序所在的位置：
$ lb-sdk http://localhost:3000/api ./sdk.js
- 您可以在
sdk.js中找到生成的 SDK，将其集成到新的项目中使用。
SDK 使用示例
这里有一个使用生成的 SDK 的示例。
在以下 HTML 文件中引入生成的 SDK：
-- -------------------- ---- -------
--------- -----
------
------
--------- -------- -----------
------- -----------------------
-------
------
--------
--- --- - ---------------
---------------------------- ------------------ -
----------------------
-- --------------- -
-------------------
---
---------
-------
-------在 HTML 中，我们可以通过 sdk.models.Post.findById 调用生成的 SDK 中的方法，调用后端的服务器 API 并返回响应。
自定义 LoopBack 应用程序的下载点
如果您的 LoopBack 应用程序不在本地，想要从其他服务器上进行下载，可以使用 --url 选项指定下载 URL：
$ lb-sdk --url http://api.example.com api ./sdk.js
配置及使用
可以在运行 lb-sdk 命令时使用 --help 选项来查看可用的选项：
$ lb-sdk --help
同时，也可以修改 Node 模块中的默认配置，以配置 SDK 生成过程中的允许设置。具体配置及说明可以在配置文件中找到：./lib/config.json.dist。
结尾
通过使用 @mean-expert/loopback-sdk-builder，我们可以避免手动编写 SDK 的复杂过程，快速生成可重用的、类型定义的 SDK，并将其打包成 npm 包方便使用。同时，您还可以根据自己的需求进行一些自定义设置，使其满足更多特定业务场景的需求。如果您在使用过程中遇到了问题，还可以在文档中的 GitHub 仓库 中寻求帮助。
希望此文对大家有所帮助！
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60066bcb967216659e24465c