Docker安装YApi文档工具

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

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

1、拉取镜像

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

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

docker images
在这里插入图片描述

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

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

  1. docker exec -it yapi /bin/sh
  2. vi ../config.json
  3. #修改内容如下
  4. {
  5. "port": "3000",
  6. "adminAccount": "admin@admin.com",
  7. "closeRegister":true, #主要是添加这句配置,这个配置是禁用注册
  8. "db": {
  9. "servername": "mongo",
  10. "DATABASE": "yapi",
  11. "port": 27017
  12. }
  13. }
  14. #保存后退出
  15. exit #退出容器
  16. docker restart yapi #重启服务

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

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

POST json

  1. {
  2. "email": "xx@xxx.com",
  3. "password": "xxx@xxx.com",
  4. "username": "xxxx"
  5. }

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

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

为中国程序员点赞!!!

发表评论

表情:
评论列表 (有 0 条评论,76人围观)

还没有评论,来说两句吧...

相关阅读