最近负责的一个项目，需要提供一些接口给第三方平台。但之前的接口文档没有或者文档散落在不同的wiki上。导致需要花费一些额外的工作时间来进行接口文档编写！
为了减少后期有可能出现的接口文档，我推荐使用YAPI。
https://hellosean1025.github.io/yapi/
yapi支持多种格式文档的导出，也支持特定接口的导出（将特定的接口设置为公开接口）
支持多种格式文档的导出
支持部分接口的导出
同时，idea有相关插件，方便开发人员将接口直接一键同步到yapi。
搜索插件：Idea YApi，进行安装
idea插件
以JSON格式配置项目
选择方法（类），右键选择Idea Yapi即可完成接口文档的同步
接口同步示例
接口定义
接口注释需要体现出对应的模块。如：资产管理-数据源管理-数据源配置。取最后一个数据源配置即可，便于接口查找
接口代码
最终同步效果为：
最近负责的一个项目，需要提供一些接口给第三方平台。但之前的接口文档没有或者文档散落在不同的wiki上。导致需要花费...
应项目组要求运用swagger技术管理项目接口文档，由于项目运用的springBoot开发，所以这里我说一下swa...
在进行接口管理过程中，正确使用文档工具能协助我们快速全面地管理接口文档。所以今天我们来谈谈接口文档以及如何使用接口...
ApiPost = 接口调试+接口文档快速生成+接口文档规范化管理+Mock API+接口流程测试。 生成Mock...
老杨写了三篇技术管理了：《技术管理总篇》，《技术管理团队篇》，《技术管理技术篇》，参见老杨的文章。 一句话小结一下...
简介 接口开发完成了，那么接下来需要编写接口文档。传统的接口文档编写都是使用word或者其他一些接口文档管理平台，...
技术管理二维表告诉你技术管理的范围、生命周期和衡量指标。 行是技术管理的范围，列是技术管理的生命周期，各个单元是技...
大家新年好，我是老杨，一位二十年经验的技术管理老兵，我准备进行技术管理十讲，致力于：解决技术管理痛点，帮助技术管理...
Apifox 接口文档、调试、Mock、自动化测试，提升 10 倍效率！ 高效、强大的接口管理平台 可视化接口文档...
1、《雷蓓蓓的项目管理实战课》2、《朱赟的技术管理课》3、《技术管理实战的36讲》4、《技术管理案例课》5、《研发...
本文标题：技术管理：接口文档管理
本文链接：https://www.haomeiwen.com/subject/fcyrsrtx.html
网友评论