2021年1月3日

接口文档规范

摘要: 什么是接口 接口全称是应用程序编程接口,是应用程序重要的组成部分。接口可以是一个功能,例如天气查询,短信群发等,接口也可以是一个模块,例如登录验证。接口通过发送请求参数至接口url,经过后台代码处理后,返回所需的结果。 为什么需要编写接口文档 由于接口所包含的内容比较细,在项目中常常需要使用接口文档 阅读全文

posted @ 2021-01-03 23:38 隔壁王书 阅读(2284) 评论(0) 推荐(0) 编辑

API文档专用工具

摘要: API文档是项目开发必备的文档之一,且随着项目不断的API化,API文档也越发重要。由于API文档不仅包含API基本信息,还包含API示例等,并且测试人员也需要使用API文档对API进行测试,所以传统的Office文档已经逐渐不能满足我们的需求,选择一个强大的API管理工具,是项目开发与后期维护的关 阅读全文

posted @ 2021-01-03 23:36 隔壁王书 阅读(302) 评论(1) 推荐(0) 编辑

如何导入Swagger文件到Eolinker

摘要: 本周的问题是关于Swagger的导入和同步 在Eolinker中,有三个地方可以导入Swagger 1、在项目列表导入,因为设计了绑定SwaggerID,导入后的api是有SwaggerID的,后续进行同步没有问题。无论是增量,全量,仅添加API都只有一个,而且按Swagger最新的数据来更新; 2 阅读全文

posted @ 2021-01-03 22:51 隔壁王书 阅读(887) 评论(0) 推荐(0) 编辑

几个在线文档接口生成工具

摘要: 好用的在线文档生成工具,具体要求如下: 1.能够实时生成在线文档 2.支持全文搜索 3.支持在线调试功能 4.界面美观 说实话,这个需求看起来简单,但是实际上一点的都不简单。 我花了几天时间到处百度,谷歌,技术博客 和 论坛查资料,先后调研了如下文档生成工具: 一、gitbook 开发语言:java 阅读全文

posted @ 2021-01-03 22:44 隔壁王书 阅读(1627) 评论(0) 推荐(0) 编辑

导航