npm 包 andela-portal-cmd 使用教程

阅读时长 3 分钟读完

介绍

andela-portal-cmd 是一个 Node.js 的命令行工具,可以让用户更加高效的和 Andela 开发中心的 API 进行交互。在使用该命令行工具前,用户需要进行安装。安装好后,用户就能够快速地在终端中使用一系列的命令快速地完成 Andela 开发中心 API 的交互操作。

安装

运行以下命令进行安装:

基本使用方法

andela-portal-cmd 支持使用如下命令:

登录

首先需要完成登录,在终端中运行如下命令登录账号:

登录后,用户的 API 密钥将被存储在本地。

获取用户信息

该命令可以获取当前登录的用户信息。

获取所有用户

该命令可以获取 Andela 开发中心的所有用户信息。

获取指定用户

该命令可以根据用户 ID 获取指定用户的信息。

获取所有项目

该命令可以获取 Andela 开发中心的所有项目信息。

获取指定项目

该命令可以根据项目 ID 获取指定项目的信息。

高级用法

自定义 API 域名

andela-portal-cmd 默认使用 Andela 开发中心的官方 API 域名,如果需要使用其他域名进行 API 请求,可以通过修改配置文件进行自定义。

运行如下命令:

例如,自定义 API 域名为 https://api.test.com,则运行:

调用 API

andela-portal-cmd 还提供了调用 Andela 开发中心 API 的通用方法:

例如,要获取指定用户的信息可以通过如下命令进行调用:

实际请求的 URI 为 https://api.andela.com/users/<user_id>

如果需要使用 POST 请求提供数据,可以使用 -d 参数:

以上命令可以把用户 ID 为 <user_id> 的用户的姓名更改为 "John"。

示例代码

以下是获取所有用户信息的示例代码:

-- -------------------- ---- -------
----- ------------ - -----------------------------
----- ------ - --- ---------------

--------------
  ----------- -- -- -
    ----- ----- - ----- ------------------
    -------------------
  --
  -------------- -- -
    --------------------- -------
  ---

该代码会在终端中输出 Andela 开发中心的所有用户信息。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60066b5c51ab1864dac6709e

纠错
反馈