使用Postman验证TFS Rest API

概述

你可能已经了解到,TFS自2015版本发布以来,开始支持通过REST API的方式提供接口服务,第三方平台可以通过通用的HTTP协议访问TFS系统,获取数据、请求编译等。REST API在原有.NET和JAVA SDK的基础上,大幅提高的TFS系统的扩展性。任何支持HTTP访问的客户端或者设备都可以实现与TFS系统的集成。

我们在使用TFS的REST API实现集成开发的过程中,往往希望首先测试和验证API的功能,这就需要一个调试和验证的API工具,经过一段时间的调研,Postman成了我的最爱。

Postman(https://www.getpostman.com/)是一款非常优秀的API开发和调试工具。它可以在Windows, Linux, MAC OS上运行,可以根据用户的需求发送各种类型的请求,例如GET, HEAD, POST, PUT, PATCH, DELETE...。这一强大的功能收到了大量开发人员的青睐。

下面通过几个简单的示例,演示如何使用Postman调用TFS的API服务器。

新建一个工作项

1. TFS新建工作项的API接口为:http://tfsserver/collection/teamproject/_apis/wit/workitems/$workitemtype?api-version=1.0

注意,需要将workitemtype替换成你需要创建的工作项,但是不要丢掉前面的$符号。

2. 在body中输入JSON数据对,传入需要提交的数据,例如标题和内容;并且选择类型为raw

3. 在Headers中指定数据内容类型(Content-Type)为application/json-patch+json

4. 点Send按钮,如果创建成功,你可以在Body返回值中看到新建的工作项的内容。如下图:

image


image

修改工作项

更新工作项的方式与新增工作项一样,只是API的URL和传入的json参数不一样

image

微软ALM MVP 张洪君 http://www.cnblogs.com/danzhang

(之前写过一个使用JavaScript调用Rest API的示例文档“初探Team Foundation Server (TFS) 2015 REST API ”,也可以供大家参考)

posted on 2018-02-08 00:31  danzhang  阅读(1215)  评论(1编辑  收藏  举报

导航