• 通过Eolinker API Studio,快速自动生成API文档


    Eolinker API Studio是一种可以为用户对API进行管理、测试、监控的工具,而使用Eolinker API解决方案最大的优势是,它使您可以将后端服务与任何技术堆栈进行对接,并同时提供丰富、强大的自动化测试功能。
    利用Eolinker API解决方案功能的最有效方法是通过代码直接生成API文档,您可以使用Eolinker的自动生成API文档功能(添加教程链接),将Swagger、Github、Gitlab或者码云的Gitee来把您的代码直接生成API。

    通过此功能,您可以在Eolinker上通过代码直接获取API,并对其直接进行开发、设计、管理、同步。

    # 怎么实现的
    若要使用Eolinker API解决方案的自动生成API文档功能,您需要一个Eolinker账户及准备好您代码仓库的相应信息,例如Swagger、Github、Gitlab或者码云的Gitee。
    1、登录www.eolinker.com,点击右上角进行免费注册,可以使用第三方平台快速注册登录服务,简单快捷。

    2、进入API管理和测试模块,新建项目后可以在项目概况中看到自动生成文档的设置选项。

    3、在弹窗中选择通过Swagger URL生成API文档,然后点击下一步:

    4、输入Swagger生成的 JSON 地址,注意该 JSON 地址需要能够通过网络访问,并且该地址返回的数据需要是 JSON 类型的数据,否则会提示无法访问该地址。

    5、配置完成后,界面会提示配置完成。此时您可以通过在项目概况页点击 立即同步 按钮,或者通过 Open API 触发同步操作。

    6、从代码仓库中扫描API文档从代码仓库中扫描API文档
    您可以给项目关联代码仓库,API 研发管理平台 能够远程读取仓库中的代码注解并自动生成 API 文档,能够识别 Swagger 2.0 的代码注解格式。
    目前支持的仓库类型有:Github、Gitlab、码云。进入项目概况页,点击 扫描代码注解生成文档 ,在弹窗中设置需要扫码的代码仓库,点击立即同步即可。

    # 最后
    一款成功的API管理工具需要有着良绝佳的易用性,能够将工作流打通并提高整体的工作效率。Eolinker API解决方案可以充当API实际管理的工具,同时通过Webhooks触发自动生成功能,调用代码仓库的代码生成工作中需要快速获取的API文档。
    当然,Eolinker API解决方案还能通过Webhooks达到更多不同的目的,今天就尝试一下发掘更多的使用方式!

  • 相关阅读:
    Sicily 1795 Table tennis
    【转】关于使用printf和scanf对short进行输入输出的一段有趣对话
    Sicily 1561 PRIME
    【读书笔记】the TeXBook 1
    Sicily 1934 移动小球
    Sicily 1817 校歌手大奖赛
    个人总结flex各种用法(转)
    ActionScript3编译运行
    Flash & Flex组件优化的杀手锏callLater
    readResolve()方法与串行化
  • 原文地址:https://www.cnblogs.com/dc20181010/p/14549358.html
Copyright © 2020-2023  润新知