zoukankan      html  css  js  c++  java
  • API在线文档

    API文档常用于帮助项目内成员协作、测试,或提供给用户参考使用。如何才能够优雅的分享API文档,使用工具是一个不错的选择。
    在线的API文档工具有很多,例如:Swagger、SosoAPI、Eolinker、Showdoc等,目前工作上使用的是Eolinker。
    在Eolinker中,您可以在线分享项目给团队以外的人,其他人可以通过分享链接在线查看API文档并且进行API测试。通过这种方式查看API文档不需要注册账号,方便查看接口文档和测试接口。
    进入API管理项目概况页面,点击在线分享项目设置,即可启用或禁用项目在线分享功能。

    可以随时开启关闭,分享后,支持不用登录就能方便地提供给想分享的人查看。如果需要访问支持设置密码,可以按照下图所示设置:

    还可以设定允许访客执行的操作:查阅API文档、进行API测试、查看状态码文档、查看项目文档等。如:
    可以查看【详细的API文档】、【发起API测试】、【查看Mock API】、【查看状态码文档】、【查看项目文档】,还可以查看【项目环境】的信息。

    查看API文档:

    发起API 测试:
    随时对API发起测试,检测API

    查看mock:
    展示各种期望、模拟实际返回数据

    状态码文档:
    注明各种返回状态码的意思

    切换环境:
    开启之后可查看项目环境,访客可以在项目分享页右上方看到环境切换菜单。
    设置访客能够看到的项目环境信息,比如开发环境、测试环境、生产环境等请求地址前缀信息等,默认为不可切换环境。

    项目文档:
    附带项目的各种文字描述、图片、文件等

    API工具提高了项目的灵活性,选择合适的API管理工具可以帮助我们更好的管理项目流程。
    Eolinker:www.eolinker.com

  • 相关阅读:
    团队开发——描绘用户场景
    学习EXTJS6(2)“Hello Usegear”
    D2007从win7升级到win10下的莫名其妙问题。
    学习EXTJS6(1)安装环境
    raize5的修改。
    EurekaLog是什么鬼?
    EditorLineEnds.ttr的困扰
    dev的汉化
    cxGrid主从表删除从表记录的困惑
    痛苦的Windows下的temp目录
  • 原文地址:https://www.cnblogs.com/dc20181010/p/14287970.html
Copyright © 2011-2022 走看看