Skip to content

Latest commit

 

History

History
71 lines (58 loc) · 2.41 KB

README-zh.md

File metadata and controls

71 lines (58 loc) · 2.41 KB

yapi-user-manager

yapi-user-manager是一个简单、方便、快捷的管理yapi用户的命令行工具。

English | 简体中文

YApi 是高效、易用、功能强大的 api 管理平台,旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API,YApi 还为用户提供了优秀的交互体验,开发人员只需利用平台提供的接口数据写入工具以及简单的点击操作就可以实现接口的管理。

1. 缘由

有一点点美中不足的是管理员也没有添加用户的入口,而在我们私有化部署之后,出于安全方面考虑,通常会关闭用户注册入口,因此如果想要添加新的账号,则需要

  1. 修改启动配置 "closeRegister":false
  2. 重启服务
  3. 用户注册
  4. 再次修改配置关闭用户注册 "closeRegister":true
  5. 再次重启服务

正如我们所见,一个创建用户操作,需要重启两次服务,会严重影响用户的正常使用,这显然不(很)太(不)方(合)便(理)。 如果可以登录Yapi数据库所在的服务器,或者说有Yapi数据库权限,直接在数据库中进行用户管理就会变得非常方便。如果能够省去拼创建用户的数据库语句,通过一条命令实现上述功能的话,那就更棒了。

2. 安装方法

注意,不管使用如下哪种方式都需根据实际情况,修改config/config.yaml文件中的配置。

2.1 源码

需要go环境

git clone https://github.com/niuzhiqiang90/yapi-user-manager.git
cd yapi-user-manager 
go run main.go add user -u name -e [email protected]

2.2 二进制包

这里下载二进制包。

tar -zxvf yapi-user-manager -linux-<version>.tar.gz
cd yapi-user-manager -linux-<version>
chmod +x yapi-user-manager 

3. 用法

3.1 添加用户

yapi-user-manager add user -u name -e [email protected]

输出

Add user successfully.
Username: xxx
Account: [email protected]
Password: 1234qwer!@#$
Please change your password after login.

3.2 重置用户密码

yapi-user-manager reset password -e [email protected]

3.3 锁定用户

yapi-user-manager block user -e [email protected]

3.4 解锁用户

yapi-user-manager unblock user -e [email protected]

3.5 删除用户

yapi-user-manager delete user -e [email protected]