魔方网表 让信息化更简单

 找回密码
 注册
查看: 8079|回复: 5

REST接口服务你用了吗

[复制链接]
laiye 发表于 2008-7-25 15:44:00 | 显示全部楼层 |阅读模式
迅捷缺陷跟踪系统2007R1支持REST方式访问,您可通过简单的JavaScript和HTML便可以与缺陷跟踪系统进行通信,可以方便的与您的其他信息系统进行集成。
目前系统提供的REST服务包括系统登录服务,缺陷的查询、增加、修改和删除。下面详细介绍每种服务的使用方法。
1)系统登录服务
在访问系统的其他服务之前,必须先通过登录服务登录系统,获取会话Key,通过会话Key访问系统的其他服务。使用登录服务时,将如下格式的XML通过HTTP POST到http://localhost: 8080/service/loginService/clientLogin,如果在其他机器访问或端口不是8080请做相应替换。
<?xml version="1.0" encoding="UTF-8"?>
<account>
<name>lihui</name>
<password>lihui</password>
<projectId>9</projectId>
</account>
其中name为缺陷跟踪系统的帐号ID,password为密码,projectId为要登录的项目ID。
登录成功后,系统会返回如下XML片段:
<ns2:loginResponse xmlns:ns2="http://login.pingway.com">MEFwcSqRUNNuWQAL1y0CeQ==</ns2:loginResponse>
其中MEFwcSqRUNNuWQAL1y0CeQ==为会话Key。
如果登录失败,例如用户名密码错或无权限则返回:
<ns2:loginResponse xmlns:ns2="http://login.pingway.com">403</ns2:loginResponse>
具体使用方法请参考迅捷缺陷跟踪系统安装目录下apache-tomcat-5.5.23/webapps/ROOT/Sample/REST/Login.html文件。
 楼主| laiye 发表于 2008-7-25 15:44:00 | 显示全部楼层

回复:REST接口服务你用了吗

2)缺陷查询服务
查询服务使用HTTP GET即可访问,服务地址为http://localhost: 8080/service/bugService/bugs/{loginKey}/{pageNo}/{pageSize},其中{loginKey}用会话Key替换,{pageNo}为页码,{pageSize}为每页显示数目。例如在浏览器中输入http://localhost: 8080/service/bugService/bugs/MEFwcSqRUNNuWQAL1y0CeQ==/1/1系统返回:
<ns2:bugs xmlns:ns2="http://bug.pingway.com">
<bugCollection>
<account_Modifier_Id>lihui</account_Modifier_Id>
<account_Modifier_Name>lihui</account_Modifier_Name>
<account_Reporter_Id>lihui</account_Reporter_Id>
<account_Reporter_Name>lihui</account_Reporter_Name>
<category_Id>27</category_Id>
<category_Name>严重</category_Name>
<extraInfo />
<id>169</id>
<module_Id>11</module_Id>
<module_Name>abcb</module_Name>
<project_Id>9</project_Id>
<project_Name>abcb</project_Name>
<projectbug_id>93</projectbug_id>
<reportTime>2007-09-13 21:24:32</reportTime>
<shortDesc>测试</shortDesc>
<status_Id>35</status_Id>
<status_Name>新建</status_Name>
</bugCollection>
</ns2:bugs>
回复

使用道具 举报

 楼主| laiye 发表于 2008-7-25 15:45:00 | 显示全部楼层

回复:REST接口服务你用了吗

3) 增加缺陷服务
增加缺陷服务使用HTTP POST,将如下格式的XML提交到http://localhost: 8080/service/bugService/bugs。
<?xml version="1.0" encoding="UTF-8"?>
<addBug>
<loginKey>pIgH6KgKC8qTK6UJsVfkpg==</loginKey>
<account_Modifier_Id>lihui</account_Modifier_Id>
<account_Reporter_Id>lihui</account_Reporter_Id>
<category_Id>27</category_Id>
<extraInfo>测试增加缺陷服务</extraInfo>
<id></id>
<module_Id>11</module_Id>
<project_Id>9</project_Id>
<shortDesc>测试</shortDesc>
<status_Id>35</status_Id>
</addBug>
成功后系统会返回如下结果:
<ns2:addBugResponse xmlns:ns2="http://bug.pingway.com">170</ns2:addBugResponse>
其中170为新增缺陷的ID。
请参考迅捷缺陷跟踪系统安装目录下apache-tomcat-5.5.23/webapps/ROOT/Sample/REST/AddBug.html
回复

使用道具 举报

 楼主| laiye 发表于 2008-7-25 15:45:00 | 显示全部楼层

回复:REST接口服务你用了吗

5) 删除缺陷服务
删除缺陷服务使用HTTP DELETE,将如下格式的XML提交到http://localhost: 8080/service/bugService/bugs/{loginKey}/{id}。

成功后系统会返回如下结果:
<deleteBug xmlns="http://bug.pingway.com"></deleteBug>
请参考迅捷缺陷跟踪系统安装目录下apache-tomcat-5.5.23/webapps/ROOT/Sample/REST/DeleteBug.html
回复

使用道具 举报

 楼主| laiye 发表于 2008-7-25 15:45:00 | 显示全部楼层

回复:REST接口服务你用了吗

6) 查看缺陷详细信息服务
查看缺陷详细信息服务使用HTTP GET即可访问,服务地址为http://localhost: 8080/service/bugService/bugs/{loginKey}/{id},其中{loginKey}用会话Key替换,{id}为缺陷ID。例如在浏览器中输入http://localhost: 8080/service/bugService/bugs/MEFwcSqRUNNuWQAL1y0CeQ==/170系统返回:
<ns2:Bug>
<account_Modifier_Id>ss</account_Modifier_Id>
<account_Modifier_Name>ss</account_Modifier_Name>
<account_Reporter_Id>ss</account_Reporter_Id>
<account_Reporter_Name>ss</account_Reporter_Name>
<category_Id>1</category_Id>
<category_Name>严重</category_Name>
<extraInfo> </extraInfo>
<id>170</id>
<module_Id>1</module_Id>
<module_Name>ss</module_Name>
<project_Id>1</project_Id>
<project_Name>ss</project_Name>
<projectbug_id>13</projectbug_id>
<reportTime>2007-09-11 17:47:12</reportTime>
<shortDesc/>
<status_Id>1</status_Id>
<status_Name>新建</status_Name>
</ns2:Bug>
回复

使用道具 举报

知恺存 发表于 2013-1-10 22:46:50 | 显示全部楼层
强强强~~,太好了,谢谢
回复

使用道具 举报

您需要登录后才可以回帖 登录 | 注册

本版积分规则

Archiver|手机版|小黑屋|魔方软件 ( 京ICP备08008787号 )

京公网安备 11010702001722号

GMT+8, 2024-4-20 14:35 , Processed in 0.083917 second(s), 15 queries .

Powered by Discuz! X3.5

© 2001-2024 Discuz! Team.

快速回复 返回顶部 返回列表