如何确认本地部署TFS 2017 Rest API各接口支持的参数?
我明白你现在的困扰——微软官网移除了TFS 2017对应的REST API参数文档,只留下了4.1和5.1版本的内容,导致你没法直接对照确认本地部署的TFS 2017支持哪些API参数。别担心,这里有几个靠谱的方法帮你解决这个问题:
本地TFS实例的内置Swagger文档:这是最准确的来源。在你本地部署的TFS服务器上,访问类似
http://<你的TFS服务器地址>:8080/tfs/_apis的路径(如果是指定项目集合,路径为http://<TFS服务器地址>:8080/tfs/<项目集合名称>/_apis),进入后就能看到对应TFS 2017版本的完整API文档,包含每个端点支持的所有参数、请求格式、响应结构等细节,完全匹配你的本地环境。发送OPTIONS请求到API端点:针对你想要确认的具体API端点,发送一个
OPTIONS请求,比如你想查询工作项相关API的参数,就请求http://<TFS服务器地址>:8080/tfs/<项目集合>/_apis/wit/workitems?api-version=3.2(TFS 2017对应的API版本范围大致是3.0到3.2)。响应内容里会明确列出该端点支持的HTTP方法、允许的参数、请求头要求等信息,动态获取的结果完全适配你的服务器版本。社区归档与离线备份:部分开发者会备份旧版本的微软API文档,或者在技术社区的归档内容里(比如Stack Overflow的历史问答、GitHub的存档仓库)能找到TFS 2017 API参数的整理内容。不过要注意,不同的TFS 2017补丁版本可能有细微差异,所以这类内容仅作参考,最终还是要以本地实例的验证结果为准。
直接测试验证:如果不确定某个参数是否被支持,可以在本地环境直接发送带该参数的API请求。如果参数不被支持,TFS通常会返回明确的错误提示,告诉你哪些参数是无效的,或者给出合法参数的可选值,通过这种方式也能快速确认参数的支持情况。
内容的提问来源于stack exchange,提问作者user5855178

