接口管理平台YApi
介绍
YApi 是高效、易用、功能强大的 api 管理平台,旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API,YApi 还为用户提供了优秀的交互体验,开发人员只需利用平台提供的接口数据写入工具以及简单的点击操作就可以实现接口的管理。
当下稍微正式一点的公司都会要求前后端联调要求编写接口文档,比如说要求word或者excel等了,这个时候你要说那么我们可以使用swagger,但是领导又会说swagger不能留档,并且显得不太正式,结果就强制要求使用word,奈何太浪费时间,通过yapi,它可以直接导出文件进行存档,并且接口内容也可以通过swagger定时同步。
GitHub:https://github.com/YMFE/yapi
Docker部署:https://github.com/fjc0k/docker-YApi
安装Yapi
自己搭建mongo
前提是需要安装mongdb用于存储数据,当前我已经安装了MongoDB,配置如下
docker run -p 27017:27017 --name mongo -e TZ=Asia/Shanghai -d mongo服务地址:192.168.1.12
端口:27017
数据库:yapi
因为设置带密码的mongodb一直没成功,所以采用了无密码的
通过docker生成yapi服务
docker run -p 8009:3000 --name yapiweb -e YAPI_ADMIN_ACCOUNT=itzhangyunpeng@163.com -e YAPI_ADMIN_PASSWORD=123456 -e YAPI_CLOSE_REGISTER=true -e YAPI_DB_SERVERNAME=192.168.1.6 -e YAPI_DB_PORT=27017 -e YAPI_DB_DATABASE=yapi -e YAPI_MAIL_ENABLE=false -e YAPI_LDAP_LOGIN_ENABLE=false -d jayfong/yapi:latest
使用了大佬提供的镜像:jayfong/yapi
详细配置还得看GitHub文档介绍,注意数据库的地址信息
开箱即用版本
# 纯粹的
docker run --rm -p 8009:3000 -d jayfong/yapi:play# 带插件的
docker run --rm -p 8009:3000 -e YAPI_PLUGINS='[{"name":"interface-oauth2-token"}]' -d jayfong/yapi:play
默认的管理员账号:
admin@docker.yapi
,管理员密码:adm1n
。
基本使用Yapi
登录
通过浏览器访问地址:http://localhost:8009/
帐号密码就是上面配置的管理员密码:YAPI_ADMIN_ACCOUNT=itzhangyunpeng@163.com YAPI_ADMIN_PASSWORD=123456
用户管理
查看用户
添加用户
个人项目
创建
展示个人项目
该个人项目只能自己才看看到
分组
创建分组
一个项目组一般为一个分组,然后其他的人都在该分组中编辑本分组的项目
分组成员
管理本分组人员操作和简单操作权限。
分组动态
展示分组内每个用户的操作记录
添加接口
修改接口
搭配swagger
关于swagger基础配置可以查看:此处
创建项目
使用前文的.net程序,并显示swagger信息,swagger地址为:http://azrng.cn1.utools.club/swagger/index.html
获取swagger的json地址
Yapi配置
本次使用的是完全覆盖,通过cron表达式配置自动同步时间。
查看同步数据
然后我们查看接口列表,这个时候我们已经看到项目的接口已经都被同步过来了
数据管理
数据导出导入
在数据管理我们可以导入数据,或者导出数据
对于我来说我常用的就是数据导出为html给留档使用。
导出预览
更多配置还需要查看官方文档
接口管理平台YApi相关推荐
- 可视化接口管理平台 YApi,让你轻松搞定 API 的管理问题
随着开发的推进,各种各样的文档会接踵而来,比如:需求文档.架构文档.接口文档等等,我们通过 SVN.Git 等可以很方便的管理,面对需求的不断变化,我们需要不断的对各类文档进行维护.但在开发阶段,针对 ...
- 推荐的接口管理平台-yapi
最近在找好用的接口管理平台,为项目的接口做统一管理.最终选择了 YApi 这个开源项目. github地址:https://github.com/ymfe/yapi: 项目需要nodejs,mongo ...
- Yapi 可视化接口管理平台部署文档
一[yabi介绍] 1.1 官网 github:https://github.com/ymfe/yapi Yapi 可视化接口管理平台 Yapi 是高效.易用.功能强大的 api 管理平台,旨在为开发 ...
- BAT都在使用的开源接口管理平台,你用了吗?
作者:Anoyi 原文:https://www.jianshu.com/p/a97d2efb23c5 介绍 给大家推荐一个开源接口管理平台YApi,众多互联网大厂都在使用 YApi 的一些客户:百度, ...
- 六大接口管理平台,总有一款适合你的!
前后端分离绕不开的接口测试 先聊一聊前端和后端分离的优点.前后端分离优点如下: 真正的实现前后端解耦,前端服务器使用 nginx: 易于发现bug,可以快速定位是谁的问题,不会出现互相踢皮球的现象: ...
- 开源项目 ——API接口管理平台数据库原型设计(三)
开源项目 --API接口管理平台数据库原型设计(三) 背景 日常我们开发人员在开发一些常用的平台时都会用到各种各样的接口,而对于这些接口的有效管理都会成为我们的一些麻烦事,一些常见的接口管理平台我们使 ...
- yapi 插件_强大的开源API接口可视化管理平台——YAPI
背景 在之前有些时日,曾经写过一个API管理平台--DOClever,但是总觉得界面上稍微差了点,刚好之前有朋友在评论区留言,让我知道了今天要介绍的这个平台YAPI,YApi 是一个可本地部署的.打通 ...
- yapi 权限_win10 x64下从0开始搭建YApi可视化接口管理平台
YApi 是高效.易用.功能强大的 api 管理平台,旨在为开发.产品.测试人员提供更优雅的接口管理服务.可以帮助开发者轻松创建.发布.维护 API,YApi 还为用户提供了优秀的交互体验,开发人员只 ...
- yapi 接口管理平台手册
文章目录 前言 背景.现状.意义 mock测试 yapi 基于项目的管理 API接口管理 mock 服务器 使用 服务端使用路径 客户端使用路径 参考资料 前言 本篇旨在让相关开发人员理解引入 y ...
最新文章
- 2021 Facebook 博士奖研金名单出炉:13位华人学者获选
- Reddit引入Envoy支持架构改造,性能显著提升
- 实锤!沙特新规,出货箱单必须显示条形码,发票必须盖章!
- 技术干货 | 闲鱼:一个优秀的 Push 平台,需要经历怎样的前世今生
- pom.xml里发布和下载包
- 贴一段Jenkins的自动发布脚本
- 每日一题丨以下哪个SQL查询的结果是2006-01-01 00:00:00
- 计算机835真题,《计算机水平考试》复习题835题(含答案)
- 第五篇 CSS入门 明白 三种嵌套形式,三种常用控制器
- 拓端tecdat|R语言贝叶斯Poisson泊松-正态分布模型分析职业足球比赛进球数
- laravel Ajax请求 X-CSRF验证问题
- 嵌入式Linux开发细分四个岗位
- 泰坦尼克号生还者预测
- 迅捷路由器设置找不到服务器,迅捷(FAST)路由器第一次怎么设置? | 192路由网
- Matlab Classification Learner
- 关于软件定时器的一些讨论
- C++ 动态创建二维数组
- 使用vue制作网页导航栏
- 算法题思路总结和leecode继续历程
- PS3111开卡量产成功教程,PS3111+ASM235CM双头板子体验,DIY固态U盘小记+PS3111开卡工具