介绍Jama API Python

Jama是一款在线领域特定的协作平台，用于管理和版本控制复杂的产品开发过程。Jama API Python封装了Jama API，通过Python代码可以使用Jama API从Jama中获取、更新和创建项目、需求、测试用例等等。

环境准备

使用Jama API Python需要以下环境：

• Python 2.7 或 Python 3.x
• requests 库
• 安全访问Jama服务器的凭证（API访问令牌或用户名和密码）

安装

可以通过 pip 安装Jama API Python：

pip install jamapy

或者使用源代码进行安装：

python setup.py install

使用示例

以下示例展示了如何使用Jama API Python通过Jama API获取项目信息：

import jamapy

JAMA_INSTANCE = "https://example.jamacloud.com"
JAMA_USERNAME = "[your_username]"
JAMA_PASSWORD = "[your_password]"

# 登录Jama服务器
jama_client = jamapy.Client(JAMA_INSTANCE)
jama_client.login(JAMA_USERNAME, JAMA_PASSWORD)

# 获取项目列表
projects = jama_client.get_projects()
for project in projects:
    print(project["fields"]["name"])

# 退出登录Jama服务器
jama_client.logout()

API文档

Jama API Python封装了Jama API的常用功能。更多详情请参考官方文档。

| 功能 | API | | ------ | ------ | | 登录 | login(username, password) | | 获取项目列表 | get_projects() | | 获取项目信息 | get_project(project_id) | | 获取需求列表 | get_requirements(project_id, page_num=0, page_size=20) | | 获取需求信息 | get_requirement(requirement_id) | | 获取测试用例列表 | get_test_cases(project_id, page_num=0, page_size=20) | | 获取测试用例信息 | get_test_case(test_case_id) | | 获取测试计划列表 | get_test_plans(project_id, page_num=0, page_size=20) | | 获取测试计划信息 | get_test_plan(test_plan_id) | | 获取测试环境列表 | get_test_environments(project_id, page_num=0, page_size=20) | | 获取测试环境信息 | get_test_environment(test_environment_id) | | 创建需求 | create_requirement(project_id, fields) | | 更新需求 | update_requirement(requirement_id, fields) | | 创建测试用例 | create_test_case(project_id, fields) | | 更新测试用例 | update_test_case(test_case_id, fields) | | 创建测试计划 | create_test_plan(project_id, fields) | | 更新测试计划 | update_test_plan(test_plan_id, fields) | | 创建测试环境 | create_test_environment(project_id, fields) | | 更新测试环境 | update_test_environment(test_environment_id, fields) | | 退出登录 | logout() |

总结

Jama API Python使得使用Jama API更加方便，通过Python代码可以轻松地从Jama中获取、更新和创建项目、需求、测试用例等等。但需要注意的是，Jama API的使用需要考虑服务器账户的安全性，同时进行相应的操作需要遵循一定的规范。