荨麻疹北京哪家医院好 http://baidianfeng.39.net/a_zhiliao/210116/8595950.html

小编推荐：一款安全、高效、无代码入侵的轻量级接口文档解析插件。

目录产品功能介绍产品架构设计效果展示接入流程未来规划团队介绍本文字，阅读时间4分钟

概要

我们在做需求项目的时候，服务端研发总要花费大量的精力去编写接口文档，特别是对于dubbo接口来说，对接的端不同，可能需要在wiki和kop编写两份接口文档，并且在需求中有大量的修改，这些修改对于前端研发来说不容易感知，同时，对于新同学来说，也无法快速找到一个项目或者一个场景下完整的接口文档。

针对于以上痛点，我们开发了一款安全、高效、无代码入侵的轻量级接口文档解析插件-

api-doc-plugin，服务端研发只需要在项目中添加一个简单的配置，就能一键上传项目中的所有接口文档信息到StarAPI平台和KOP平台。

然后研发和测试同学就能在StarAPI平台看到项目中所有接口信息，同时研发能在KOP极速创建接口，一键生成kop文档，彻底告别手动的繁琐配置。

1.

产品功能介绍

▌现有研发流程

"系统设计评审"-"接口定义"-“kop手动配置"-”编码“-”联调“-”测试发布“-

或

"系统设计评审"-"接口定义"-“wiki文档编写"-”编码“-”联调“-”测试发布“

可以看到我们有时候不仅仅需要在wiki上编写文档，还需要去kop手动配置文档，且wiki分散到各地，研发同学无法看到一个完整项目的文档信息。

▌接入插件之后的研发流程

"系统设计评审"-"接口定义"-“一键生成接口文档"-”编码“-”联调“-”测试发布“

"系统设计评审"-"接口定义"-“一键生成接口文档"-”kop极速创建“-”联调“-”测试发布“

▌插件主要功能

一键生成接口文档信息

项目纬度聚合管理接口文档信息

kop极速创建功能

.

产品架构设计

.

效果展示

▌StarAPI平台效果

以项目组和项目纬度聚合所有工程

每个工程都有对应的Api信息，并且支持不同版本

自动生成入参和出参示例

▌KOP极速创建功能

选择极速创建

粘贴工程里面的api左边，

点击解析后下一步

选中需要注册的接口一键生成

提交审核

4.

接入流程

▌starAPI平台注册sshkey,并且创建工程，获取appkey