如何使用交互的API文档吗

qt提供交互式的API文档,使您能够从大摇大摆UI API调用。qt用户可以使用这个交互式文档:

  • 探索和学习支持的api

  • 复制API请求的例子使用类似的语法在他们的代码

  • 出口在多种语言示例代码:Java。c#、Python和Ruby

验证样本的账户

按照以下步骤使用交互式的API文档:

  1. 点击链接qtest.dev.188金宝搏app苹果下载软件tricentis.com。

  2. 复制访问令牌,这是一个长的字母代码下显示用户名/密码线。

  3. 单击授权按钮。

  4. 在可用的授权对话框中,粘贴如下语法:持票人<访问令牌>,<访问令牌>是你复制访问令牌。

    例如:不记名14 f8f12d f85e - 497 b - 91 d9 e33b12——687184

  5. 点击授权。

  6. 授权成功后,对话框将显示“授权”。

    点击“X”按钮关闭窗外,这样您就可以开始使用交互式“试试”功能。

在某些情况下,该API令牌可能被撤销,你可以先试着登录API来检索新令牌,然后重启第三步。

实验与API

  1. 折叠或展开一个实体资源显示或隐藏其操作(删除、GET、POST、PUT)。

  2. 选择一个实体,一个操作,并输入参数值。互动的API接口指导你通过验证请求,比如如果你是失踪的一个必需的字段。

  3. 点击执行执行操作使用你提供的输入。

  4. 或语法的示例复制到您的代码。

例子:

尝试创建一个需求API,遵循这些步骤:

  1. 寻找项目从顶部的文档ID。或者,你可以尝试获得多个项目的API,然后寻找的ID qConnect——示例项目的反应。

  2. 单击向右箭头模块链接扩展模块API的部分。

  3. 点击蓝色的得到按钮来扩大获得多个模块的API。

  4. 输入projectID使用ID您在步骤1中找到。

  5. 单击执行使用提供的输入按钮来执行调用。

  6. 从身体的反应,选择一个ID的任何模块。您将使用在这个模块创建一个需求。

  7. 单击向右箭头的需求链接到API部分扩大需求。

  8. 点击绿色的帖子按钮扩展API来创建一个需求。

  9. 单击试试按钮。

  10. 在步骤1中输入projectID当你发现。请求主体,删除属性数组,输入要求的名称和parent_id使用模块ID您在步骤6中找到。

  11. 单击执行使用提供的输入按钮来执行调用。

  12. 检查结果的身体反应。

  13. 复制请求体中的示例使用类似的语法到您的代码。

出口样本库

目前,可以生成示例代码为Java, c#, Python和Ruby。

  1. 从顶部的工具栏单击所需的语言,比如Java。

  2. . tgz文件下载。提取下载文件。

    提取的文件将包含以下项目:

    • README.md:这应该是你的起点。它会指导你安装API客户端库,也为您提供一个例子很容易使用图书馆开始编写代码。

    • 主要java \ src \ \ java \ io \大摇大摆\ client \模型:它包含所有建模对象的定义。

    • 主要java \ src \ \ java \ io \大摇大摆\ client \ api:它包含源代码的API服务的包装器。

例子:

下面的代码片段是一个例子,如何创建一个需求。它包括以下步骤:

  1. 身份验证。为了获得一个授权令牌,你可以使用方法postAccessToken类LoginApi。

  2. 从你的qt管理器实例检索所有可用项目,然后选择第一个。

  3. 检索所有模块从所选项目,然后选择第一个。

  4. 下创建一个新的需求所选模块。