树莓派4B(Raspberry Pi For NAS):YApi可视化接口管理平台

NO.1
YApi

github地址

​https://github.com/YMFE/yapi

YApi 是一个可本地部署的、打通前后端及QA的、可视化的接口管理平台

img

不过这个项目最近一次提交更新实在两年前,也就是近三年没有维护了

后端同事有推荐后起之秀apifox

但是首先它不是开源的,进行私有化部署需要联系工作人员微信咨询价格

其次和x里网盘一样,当初铺天盖地的广告,再好的功能体验,看到无脑宣传已经骨子里反感了,何况要是一不小心和所谓的不限速保证一样,后期限速,各种路数等着你

部署YApi平时主要用于mock数据测试,简单https和延时测试等

NO.2
YApi安装

参考以前的文章

2020年<<yApi,高效,易用,可视化接口文档管理平台>>

2022年<<docker-compose安装yapi(接口文档)>>

新建docker-compose.yml

version: '3'

services:
yapi-web:
image: jayfong/yapi:latest
container_name: yapi-web
ports:
- 3022:3000
environment:
- YAPI_ADMIN_ACCOUNT=admin@gmail.com
- YAPI_ADMIN_PASSWORD=123456
- YAPI_CLOSE_REGISTER=true
- YAPI_DB_SERVERNAME=yapi-mongo
- YAPI_DB_PORT=27017
- YAPI_DB_DATABASE=yapi
- YAPI_MAIL_ENABLE=false
- YAPI_LDAP_LOGIN_ENABLE=false
- YAPI_PLUGINS=[]
depends_on:
- yapi-mongo
links:
- yapi-mongo
restart: unless-stopped
yapi-mongo:
image: mongo:4.4.16
container_name: yapi-mongo
volumes:
- ./data/db:/data/db
expose:
- 27017
restart: unless-stopped

其中3022为对外开放的端口

YAPI_ADMIN_ACCOUNT为自定义管理员账号名称

YAPI_ADMIN_PASSWORD为自定义管理员账户密码

开放端口

sudo ufw allow 3022

拉取镜像并启动服务

docker-compose up

第一次会报错(看似提示TLS错误)

第二次就好了

img

NO.3
YApi使用

访问IP:端口

img

输入账户名和密码

详情查看docker-compose.yml的配置

本文演示的账户:admin@gmail.com

本文演示的密码:123456

img

使用YApi创建一个API

img

浏览器访问API

img

具体的使用请参考官方文档

https://hellosean1025.github.io/yapi/documents/index.html

img

NO.4
Tips

后期的NAS系列会随手记录一些日常使用的应用服务

如办公系列,手绘画板Excalidraw,流程图drawio,思维导图KityMinder,Office三件套,MarkDown等

如开发系列,代码管理Gitlab,项目管理禅道,自动化部署Jenkins,  原型设计Penpot,错误上班Sentry,消息订阅MQTT等

END.

参考阅读

<<树莓派4B(Raspberry Pi For NAS):calibre web电子书库>>

<<树莓派4B(Raspberry Pi For NAS):nextcloud 云盘 办公套件>>