Docker安装YApi文档工具

爱被打了一巴掌 2023-10-02 17:14 1阅读 0赞

Ypai在安装之前还需要Node环境和MongoDb，大家自行安装一下

1、拉取镜像

> docker pull registry.cn-hangzhou.aliyuncs.com/anoy/yapi

2、查看镜像是否下载下来

> docker images  
> ![在这里插入图片描述][0b75a020085b48bb8a46d0abf1d78526.png]

3、先运行起来mongo

> docker run --restart always -v /data/mongodb:/data/db -d --name mongodb mongo

–restart always 是重启策略  
\-v /data/mongodb:/data/db -v是挂载的路径格式是 宿主机路径:容器内路径  
\-d 表示后台运行  
–name 容器名称

4、运行起来mongo后运行yapi容器初始化

> docker run -it --rm --link mongodb:mongo --entrypoint npm --workdir /api/vendors registry.cn-hangzhou.aliyuncs.com/anoy/yapi run install-server

–link mongodb:mongo是绑定mongo的容器地址，mongodb是容器名，关于link就不多赘述了，关于网络的  
初始化yapi后会显示初始化的账号密码  
初始化管理员账号成功,账号名：“admin@admin.com”，密码：“ymfe.org”

5、运行yapi

> docker run -d --restart=always --name yapi --link mongodb:mongo --workdir /api/vendors -p 3001:3000 registry.cn-hangzhou.aliyuncs.com/anoy/yapi server/app.js

至此就算是完成了，云服务器的话需要在安全组开放暴露端口，如果不想让其他人随便注册的话可以进行一下操作

docker exec  -it yapi /bin/sh
    
    vi ../config.json 
    
    #修改内容如下
    {
      "port": "3000",
      "adminAccount": "admin@admin.com",
      "closeRegister":true, #主要是添加这句配置，这个配置是禁用注册
      "db": {
        "servername": "mongo",
        "DATABASE": "yapi",
        "port": 27017
      }
    }
    #保存后退出
    
    exit #退出容器
    
    docker restart yapi #重启服务

禁用注册后怎么添加用户呢，登录yapi，然后添加一个项目，增加一个注册用户接口

地址为：http://yapi:端口/api/user/reg

POST json

{
      "email": "xx@xxx.com",
      "password": "xxx@xxx.com",
      "username": "xxxx"
    }

每次注册完成后，需求退出重新进入，不然有垮session问题

这个还需要两个工具：  
1、在线调试插件：链接：https://pan.baidu.com/s/1-AbOzZcAlDk9kFeT-ZCKeg  
提取码：yzjx  
2、谷歌拓展插件：链接：https://pan.baidu.com/s/1WYUGmkmqwWRCFdDD4Udrgg  
提取码：41k4  
谷歌拓展插件教程：https://juejin.im/post/5e3bbd986fb9a07ce152b53d

为中国程序员点赞！！！

[0b75a020085b48bb8a46d0abf1d78526.png]: https://img-blog.csdnimg.cn/0b75a020085b48bb8a46d0abf1d78526.png