使用 Azure Devops Git Api 在浏览器中查看 UML 文件

Use Azure Devops Git Api to view UML file in browser

在我们的团队中,我们遵循文档即代码的方法,并在我们的 git 存储库中有一些 plantUML 文件,该存储库由 azure devops 服务器托管(即,在内部部署)。现在我们想在另一个网站上将 UML 图作为 hyperlinks 提供。这个想法是,如果用户使用 chrome 浏览并安装了 plantUML 查看器扩展,他们可以通过单击 link.

在浏览器中查看图表。

我们使用 REST API 与 git 存储库交互,如下所示:

https://tfs.contoso.com/tfs/DefaultCollection/foo/_apis/git/repositories/bar/Items?path=%2Fdocs%2Fdiagram%2FContainerDiagram.uml&versionDescriptor%5BversionOptions%5D=0&versionDescriptor%5BversionType%5D=0&versionDescriptor%5Bversion%5D=develop&download=false&resolveLfs=true&api-version=5.0-preview.1

这里当然tfs.contoso.com替换为我们的azure devops服务器主机,foo为团队项目的id或名称,bar为存储库的id或名称。

不幸的是,Chrome 下载文件而不是在浏览器中显示它。我的猜测是,虽然安装了扩展程序,但它没有机会呈现内容。如何实现内容显示而不是下载?

Use Azure Devops Git Api to view UML file in browser

如果我使用相同的 REST API,我将得到相同的结果“Chrome 下载文件而不是在浏览器中显示它” =15=] 和你一样。

要解决此问题,请尝试使用 REST API Source Providers - Get File Contents:

GET https://dev.azure.com/{organization}/{project}/_apis/sourceProviders/{providerName}/filecontents?&repository={repository}&commitOrBranch={commitOrBranch}&path={path}&api-version=5.0-preview.1

注:

  • 跳过 serviceEndpointId.
  • 对于providerName。简而言之,您可以使用 TfsGit。你可以从 list of source providers.
  • 中得到这个值

您可以参考 了解更多详情。

我的测试结果: