在前端开发的过程中，我们经常需要与后端程序员协作。为了方便我们获取后端接口信息，现在有很多工具可以帮助我们自动生成 API 文档和 SDK。其中，npm 包 @36node/swagen 就是一款非常实用的工具。
本文将详细介绍如何安装和使用 @36node/swagen，包括生成 API 文档和生成 SDK。这些内容既有指导意义，也很有深度和学习意义。
安装 @36node/swagen
在使用 @36node/swagen 之前，需要使用 npm 安装该包。可以通过以下命令完成安装：
npm install -g @36node/swagen
使用 -g 参数可以全局安装该工具。
生成 API 文档
在使用 @36node/swagen 生成 API 文档之前，需要先了解要生成文档的 API 的地址。一般情况下，API 地址的格式是 http://{host}/{prefix}/{version}/{path}，其中：
host：API 的主机地址，如api.example.com。prefix：API 的前缀，一般是项目名，如app。version：API 的版本号，一般是数字，如v1。path：API 的具体路由，如/users。
例如，假设有一个获取用户信息的 API 地址是 http://api.example.com/app/v1/users，那么我们需要通过以下命令生成该 API 的文档：
swage http://api.example.com/app/v1/users
使用该命令后，@36node/swagen 会根据 API 的返回结果自动生成文档，并输出到终端上。
生成 SDK
除了生成 API 文档，@36node/swagen 还可以帮助我们生成 SDK。在使用该功能之前，需要先了解 SDK 的语言和类型。
@36node/swagen 支持生成以下语言和类型的 SDK：
- JavaScript（Promise 和 Callback）
- TypeScript（Promise 和 Callback）
- Python（Requests）
- C#（HttpClient）
- Go
例如，我们想要在 JavaScript 中生成 Promise 形式的 SDK，并保存到 sdk.js 文件中，可以使用以下命令：
swage --type javascript --style promise --outfile sdk.js http://api.example.com/app/v1/users
使用该命令后，@36node/swagen 会根据 API 的返回结果自动生成该 SDK 的代码，并保存到指定的文件中。
以下是 TypeScript Promise 形式的示例代码：
-- -------------------- ---- -------
------ ------ - ------------- - ---- --------
------ ----- -------------- -
------- ------- --------------
-------------------- ------- -
----------- - --------------
--------
---
-
----- ----------- --------------- -
----- -------- - ----- -------------
------- ------
---- ---------
---
------ --------------
-
----- ------------------ ------------------- ------------- -
----- -------- - ----- -------------
------- -------
---- ---------
----- -------
---
------ --------------
-
-- --- ------
-总之，@36node/swagen 是一款非常实用的工具，可以帮助我们更快速、更准确地获取后端接口信息。希望本文的介绍能够帮助读者掌握 @36node/swagen 的使用方法，并在实际开发中得到应用。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/155226