Panda Api 基于 Rust 的接口设计工具

程序名称:Panda Api

授权协议: MIT

操作系统: 跨平台

开发语言: Rust

Panda Api 介绍

Panda api 是一款接口设计工具,它能够生成文档、提供接口模拟服务(在你没写任何代码之前)、自动测试后端接口,有效提升项目的开发效率和质量。

为什么要用Panda Api?

提升开发效率 和 开发质量:

Panda Api
能够在开发过程中隔离前后端,让前端随心所欲的掌控接口的请求和返回,而不需要后端开发人员介入。开发环境是影响研发效能最大的一个因素之一,不稳定的上游接口环境会让一个非常简单的需求轻松消耗掉数天的时间。当后端的接口还未开发完成,或者接口忽然因为后端某个开发中的功能突然不能工作时,Panda
api可以快速提供接口。

Panda Api可以提供一个非常高效的前端开发环境和后端测试环境,什么是一个好的开发环境呢?

1、稳定

好的开发环境应该是稳定可用的,不应该在开发过程中受到其他开发人员影响,服务频繁挂掉或者频繁改变,前后端开发的团队成员就深有体会,两边相互影响,然后又导致相互等待,非常影响开发状态和效率。然而很多团队一直是在以这样低效的方式在推进。

2、快速验证

修改代码能够在尽可能短的时间内得到验证也是一个基本诉求,这也是为什么大部分前端构建都会关注 Hot reload 和更高级的HMR
。有些场景下一次简单前端的修改就要经过长时间等待等待后端开发完成,例如依赖上游修改接口的返回内容,需要修改后端的程序然后重新部署,需要走一遍完整的发布流程来测试某个修改调整,这种改一行等几十分钟的开发方式对效率的拖累是极其恐怖的。

3、一致性

很多项目,因为参与人员少,觉得不需要写什么文档,直接就讨论后开始开发。开发到后面就会发现,大家的共识是不一致的,进一步引发争论和项目的重新调整,如果中途换人或者半年以后再来维护这个项目,就很容易变成一个可怕的泥潭,所有人都不愿意去碰。原因就是一开始我们就没有形成文档。传统的接口文档确实很费时间,Panda
api把文档即服务做好,写文档变成了一个更高效的开发方式。

开发者对于当前的需求应该是有确切认知的,而不是一直不停的怀疑自己的理解到底对不对,相关接口的字段是什么意思。

Panda Api是如何解决好这几个问题

Panda Api的三个核心服务:

  1. 提供前后端的开发的接口文档

  2. 提供前端开发的接口服务

  3. 可以进行后端接口测试

Panda Api 接口文档的工具提供以下功能:

  1. 提供一份可以前后端浏览的接口文档

  2. 使用json或json5语法来写文档,操作成本、学习成本非常低

  3. 接口文档也可以像代码一样进行版本控制,前后端都有维护的权限。Panda api依赖git等版本管理工具来做

  4. 可以在定义好文档后,立即为前端开发提供接口服务,不用等待后端开发完成。为前端支持各类请求:GET, POST, PUT, DELETE, OPTIONS

  5. 可以使用这个工具进行前端测试和后端测试

  6. 可以像Mock一样,自动生成相关测试数据

Todo 还在设计开发的功能

  1. 支持多种开发环境切换,例如开发环境、测试环境、正式环境

  2. 支持websocket方式为前端开发提供测试接口服务;支持用websocket方式作为客户端进行后端服务测试

  3. 其它等你使用后来告诉我

Panda Api 项目地址:

https://github.com/arlicle/panda-api

Panda Api 如何使用

快速简单的写好第一个接口文档 使用说明(一)
接口文档的高级配置 使用说明(二)
相关字段说明
test_data使用说明
Auth接口权限配置说明

接口文档的例子

  1. Basics

  2. Inherit from models

  3. Global field settings

Panda Api 官网

https://github.com/arlicle/panda-api

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。

相关推荐


MuPlayer 是一款跨平台、轻量级的音频播放解决方案,是百度@音乐前端团队开发维护的浏览端音频播放内核,它基于HTML5
OS FLV 是一个 开源和可嵌入网页的flv播放器。 这个播放器拥有大量的选项可以通过嵌入代码进行设置.
DewPlayer音乐播放器,样式很简单,而且很实用.播放器可以根据自己的喜好改变颜色,也算比较个性化吧.但唯一的不足就是只支持MP3格式的音乐。
JW FLV MEDIA PLAYER是一个开源的在网页上使用的Flash视频、音频以及图片播放器,支持 Sliverlight
Speakker 是一个基于 Web 浏览器的音乐播放器,只提供很多高级播放功能包括播放列表管理和分享。
Player Framework 是一个开源的支持 HTML5 的视频播放器框架,同时也支持 Silverlight 和 Windows Phone
Sewise Player是一款专业的免费网页视频、流播放器,它功能强大,体积小,跨平台,使用方便简洁、随心所欲:
SoundManager 2 利用 HTML5 和 Flash 技术提供了稳定和阔平台的音乐播放功能,只有 10K 的 JS 包。
xPlayer v1.0 特性: 文件大小 9.78kb; 可以自定义皮肤; 3.支持 http 和 rtmp 视频; 4.音量调节,全屏播放,拖拽播放;
XPlayer 豆瓣音乐播放器 特点: 1.自动侦测Douban网页的歌曲 2.Douban网页关闭,歌曲能够继续播放
歌词 插件 最新更新,扩展性能稍微有点提升了, 不多说了,更多敬请查看首页http://luochunzong.sinaapp.com/?p=84
ABPlayerHTML5是一个在HTML5下的弹幕播放器(同步显示视频于评论)实现。类似功能的播放器可以参考基于Flash的MukioPlayer和PADPlayer。
AudioPlayer.js 是一个 jQuery 的插件,实现了 HTML5 的音乐播放器,无需任何图片,实现了响应式布局,支持触摸操作。
替换中国大陆主流视频网站的 Flash 播放器为 HTML5 播放器 使用 Mac 的同学都可能碰到过在线看视频引起机子风扇狂转、机身发烫等情况,这是因为 Flash 占用了过多系统资源的缘故。
AetherPlayer 是一个类CD的轻量HTML5播放器,特别适合博客及个人站点使用。它漂亮得不像……咳,这边吹牛的话就不说了。
专注、极致、智慧,国内外为数不多不依赖开源框架、跨平台(windows/android/iOS)、公网推送(支持rtmp)-播放(支持rtmp/rtsp)业界真正靠谱 的超低延迟。
node-kugou-client 是 Node.js 酷狗客户端。 安装 npm install node-kugou-client 使用 var kugou = require(\"node-kugou-client\");
Youku HTML5 播放器扩展 —— 告别 flash 和广告 关于官方内测 html5 播放器 Firefox ( xpi 直接安装) ( firefox 50.0+)
Chimee 由奇舞团研制的 h5 播放器,它支持 mp4、m3u8、flv 等多种格式。通过插件式开发,能满足业务方快速迭代、灰度发布等要求。让开发者能够轻松快捷地完成视频场景的开发。
OneVideo是一款基于OneBase+UniApp开发的小视频播放移动应用。