比swggaer更好用的接口文档工具

简介: 今天给大家推荐一个新接口工具:YesApi接口大师。YesApi接口大师(5合1):Admin接口管理后台,看这个名称就知道,这个工具很符合国内程序员、以及技术小白使用。通过网站界面,它能帮你轻松管理API接口,除了可以自动生成接口文档、还能生成API接口源代码、通过界面鼠标就能开发接口,一键、快速发布、管理和开放你的API接口。

Swagger是一个可以根据Restfull接口源代码注解,自动生成接口文档的工具,同时支持在线接口调试。

但是,要想生成完整的接口文档,还需要编写大量的注解。而且,对于技术小白,还得要先写接口源代码,不能通过界面的方式快速一键生成API接口和接口文档。

YesApi接口大师简介

今天给大家推荐一个新接口工具:YesApi接口大师。

YesApi接口大师(5合1):Admin接口管理后台

看这个名称就知道,这个工具很符合国内程序员、以及技术小白使用。通过网站界面,它能帮你轻松管理API接口,除了可以自动生成接口文档、还能生成API接口源代码、通过界面鼠标就能开发接口,一键、快速发布、管理和开放你的API接口。

官方介绍是:YesApi接口大师,是一套针对API接口进行快速研发、管理、开放以及收费的
软件产品、源代码和解决方案。基于PhalApi开源接口框架+Vue前后端分离,可用于快速搭建各类API接口平台。支持:API接口开发 零代码 / 低代码 / 纯代码 / 迁移导入;支持:数据库 MySQL / MsServer / PostgreSQL / Oracle等。

如何把Swagger.json批量导入YesApi接口大师

如果需要快速、批量开放你原有的API接口,可以把Swagger.json批量导入到YesApi接口大师。

在API接口管理后台,可以一键导入swaager.json文件,然后选择性地开放你的API接口。

例如,导入前的swagger接口列表(从Swggaer官方导出的json文件):

上传导入时,可以勾选需要开放的swagger接口:

导入后,对API接口的二次开发和调整,发布接口后即可在前台在线接口文档查看和访问使用。

通过界面鼠标就能开发接口

不管是通过swagger导入的接口,还是在接口管理后台添加的接口,都可以通过 “界面+鼠标” 的方式,让你快速、轻松对接口进行可视化、标准化的管理。

来看看接口管理后台的列表界面,还可以支持接口分组管理,找接口很是方便。

再来看下单个接口的可视化界面编辑和操作。

自动生成API接口源代码

下面是批量导入Swagger后,YesApi接口大师生成的接口源代码,来看一下它的格式。使用的是PHP开发语言。

对应的接口源代码是,

public function Handle() {
        // 接口参数获取
        $loginName = $this->loginName; // 账号接口参数
        $oldPassword = $this->oldPassword; // 原密码接口参数
        $newPassword = $this->newPassword; // 新密码接口参数
        // 结果返回
        $rs = array(
            'code' => 0, // 状态码
            'message' => "", // 响应信息
            'data' => "", // 数据
        ); 
        // API接口对接(内部接口,或上游接口)
        // TODO: 接口地址,请更换成你需要请求的接口地址
        $apiUrl = 'http://www.xxxxxxx.com/xxxxx/updatePassword';
        $apiParams = array(
            'loginName' => $loginName, // 账号
            'oldPassword' => $oldPassword, // 原密码
            'newPassword' => $newPassword, // 新密码
        );
        $curl = new \Base\Domain\Swagger\SwaggerHTTPClient();
        // POST请求
        $curlRs = $curl->post($apiUrl, $apiParams);
        // 解析请求数据
        $httpData = json_decode($curlRs, true);
        // TODO:加工处理并返回结果
        if (isset($httpData['code'])) $rs['code'] = $httpData['code']; // 返回状态码
        if (isset($httpData['message'])) $rs['message'] = $httpData['message']; // 返回响应信息
        if (isset($httpData['data'])) $rs['data'] = $httpData['data']; // 返回数据
        return $rs;
    }

可以注意到有几个很贴切好用的开发设计,1、后台默认导入到 Swagger分组(不会在前台展示),方便统一管理;2、生成导入后,会统一提供了一个 封装预设好的 请求SDK类 \Base\Domain\Swagger\SwaggerHTTPClient(),方便统一调整内部请求头部信息、鉴权等。以后只改这一处就可以了。3、还提供了请求原来Swggaer接口的参数和返回结果的处理封装,方便进行二次加工处理。

自动生成接口文档

导入和发布后,前台也可以看到全部的接口。也支持接口的分类展示,在线测试等。

例如,有接口列表页,支持搜索。

单个的接口文档,支持在线接口测试、接口调试(通过表单数据和JSON数据两种提交方式)、快速复制接口地址、还能查看到接口示例和推荐接口等。更厉害的是,这个在线接口模板,也是支持二次开发的。

小结

今天对YesApi接口大师这个接口管理工具就先介绍到这里。感兴趣的技术开发小伙伴,可以到 PhalApi开源接口框架官网了解和免费体验使用~

相关文章
|
1月前
|
JSON 前端开发 API
后端开发中的API设计与文档编写指南####
本文探讨了后端开发中API设计的重要性,并详细阐述了如何编写高效、可维护的API接口。通过实际案例分析,文章强调了清晰的API设计对于前后端分离项目的关键作用,以及良好的文档习惯如何促进团队协作和提升开发效率。 ####
|
3月前
|
存储 前端开发 API
告别繁琐,拥抱简洁!Python RESTful API 设计实战,让 API 调用如丝般顺滑!
在 Web 开发的旅程中,设计一个高效、简洁且易于使用的 RESTful API 是至关重要的。今天,我想和大家分享一次我在 Python 中进行 RESTful API 设计的实战经历,希望能给大家带来一些启发。
43 3
|
4月前
|
监控 数据可视化 测试技术
Apifox 如何进行 API 自动化测试?经验之谈
选择 Apifox 来进行 API 自动化测试能够确保每次迭代的质量,避免引入新的 bug,还要实现自动化测试、定时测试、产品监控、可视化测试、持续集成等,帮助提高效率,通过设计和执行有针对性的测试用例,来全面验证产品功能,确保软件系统能够正常运行,减少上线后的问题。
Apifox 如何进行 API 自动化测试?经验之谈
|
7月前
|
前端开发 IDE Java
比Swagger更好用的工具
比Swagger更好用的工具
244 2
比Swagger更好用的工具
|
7月前
|
前端开发
阿萨学工具:Apifox的高级Mock 功能
阿萨学工具:Apifox的高级Mock 功能
214 0
|
7月前
阿萨学工具: Apifox 的智能Mock功能
阿萨学工具: Apifox 的智能Mock功能
124 0
|
7月前
阿萨学工具: Apifox 的自定义智能Mock功能
阿萨学工具: Apifox 的自定义智能Mock功能
281 0
|
Java 测试技术 API
探索Swagger:简化API文档管理与测试的利器
在现代的应用开发中,API(Application Programming Interface)是不可或缺的一部分,用于实现不同系统之间的通信和数据交换。然而,对于开发者来说,编写和管理API文档以及进行API测试可能是繁琐的任务。Swagger作为一款强大的API文档生成和测试工具,为我们提供了一种简化的解决方案。本文将深入探讨Swagger的基本概念、特点,以及如何在实际应用中使用它进行API文档管理和测试。
146 1
|
网络协议 数据可视化 测试技术
我发现了一款高效管理接口文档的神器
痛点;什么是eolink;为什么选eolink;eolink初体验;安装注册;接口文档管理;自动同步接口;在线接口文档;接口调试
396 1
我发现了一款高效管理接口文档的神器
|
JSON 前端开发 数据可视化
再见丑陋的 Swagger,这个API神器界面更炫酷,逼格更高,体验更好
代码未动,文档先行 其实大家都知道 API 文档先行的重要性,但是在实践过程中往往会遇到很多困难。 程序员最讨厌的两件事:1. 写文档,2. 别人不写文档。大多数开发人员不愿意写 API 文档的原因是写文档短期收益远低于付出的成本,然而并不是所有人都能够坚持做有长期收益的事情的。 作为一个前后端分离模式开发的团队,我们经常会看到这样的场景:前端开发和后端开发在一起热烈的讨论“你这接口参数怎么又变了?”,“接口怎么又不通了?”,“稍等,我调试下”,“你再试试..."。 那能不能写好 API 文档,大家都按文档来开发?很难,因为写文档、维护文档比较麻烦,而且费时,还会经常出现 API 更新了
下一篇
DataWorks