如何为VSTS Service Endpoint添加类似Jenkins的验证链接？

我之前折腾过类似的需求，刚好能给你一些实用的步骤来搞定这个验证链接功能~

• 第一步：先搞定验证逻辑的后端接口
  你需要在服务端点扩展里实现一个专门的验证API，核心作用就是接收端点的配置参数（比如目标URL、凭据信息），然后执行实际的连通性校验（比如尝试发起请求、验证权限），最后返回明确的验证结果。这个接口要能处理成功、失败两种情况，失败时还要返回具体的错误原因。

• 第二步：给端点配置UI加个验证按钮
  在你的端点配置页面的HTML模板里，添加上验证按钮，再用JS绑定点击事件来调用刚才的验证接口。举个简单的例子：

  <div class="form-group mt-3">
    <button id="verifyEndpointBtn" class="btn btn-success">验证连接</button>
  </div>
  

  对应的JS代码大概是这样：

  document.getElementById('verifyEndpointBtn').addEventListener('click', async () => {
    // 先获取用户填写的端点配置信息
    const endpointUrl = document.getElementById('endpointUrlInput').value;
    const authToken = document.getElementById('endpointTokenInput').value;
  
    try {
      // 调用验证API
      const response = await fetch('/_apis/your-extension/validate-endpoint', {
        method: 'POST',
        headers: {
          'Content-Type': 'application/json',
          'Authorization': `Bearer ${VSS.getAccessToken()}`
        },
        body: JSON.stringify({ url: endpointUrl, token: authToken })
      });
  
      const result = await response.json();
      if (result.isValid) {
        alert('连接验证成功！');
      } else {
        alert(`验证失败：${result.errorMsg}`);
      }
    } catch (err) {
      alert(`验证过程出错：${err.message}`);
    }
  });
  

• 第三步：在扩展Manifest里注册验证服务
  要让VSTS识别到你的验证逻辑，得在扩展的manifest.json里注册这个验证服务的关联信息，指定对应的端点类型和验证接口路径。示例配置如下：

  "contributions": [
    {
      "id": "custom-endpoint-validation",
      "type": "ms.vss-endpoint.endpoint-validation-service",
      "targets": ["ms.vss-endpoint.endpoint-types"],
      "properties": {
        "endpointType": "你的自定义端点类型ID",
        "validationUrl": "/_apis/your-extension/validate-endpoint"
      }
    }
  ]
  

• 第四步：规范验证结果的返回格式
  你的验证API返回的JSON要符合VSTS的预期格式，这样前端才能正确解析：

  {
    "isValid": true,
    "errorMessage": "",
    "warningMessage": ""
  }
  

  如果验证失败，把isValid设为false，并在errorMessage里写清楚失败原因（比如“无法连接到目标服务器”“令牌无效”）。

另外还有几个小细节要注意：

• 确保你的扩展有足够的权限访问验证所需的资源，要是需要调用外部服务，记得处理好跨域或者在后端做请求代理。
• 测试阶段可以先在本地模拟验证逻辑，没问题再部署到VSTS扩展市场。

内容的提问来源于stack exchange，提问作者Nitin Parashar