Using Github, Azure Devops, Gitlab, Bitbucket, SwaggerHub with “Visualize OpenAPI (Swagger) documentation” App

IMPORTANT: Security risks associated with the feature when using private repositories!

  • Assign the minimum required (read only) permissions when generating a token or service user account for remote repository.
  • Carefully grant the access to the pages that contain widget using remote repository.
  • Do not configure application to use private remote repositories on the public pages.
  • For a sensitive remote repositories copy and paste the source of the specification to the widget on the Confluence page, do not specify username/password or access token in the widget.

Github

  • https://github.com/stripe/openapi/blob/master/openapi/spec3.json
  • https://raw.githubusercontent.com/stripe/openapi/master/openapi/spec3.json
  • https://api.github.com/repos/stripe/openapi/contents/openapi/spec3.json?ref=master

Microsoft Azure DevOps

  • https://dev.azure.com/microsoft/windows/_git/windows10?path=general%2Fcommand.yaml
  • https://dev.azure.com/microsoft/windows/_git/windows10/commit/4e3aa3b39a2a6488b3e0ac1d7d6aaf22cdeb0d5e?refName=refs%2Fheads%2Fmain&path=general%2Fcommand.yaml&_a=compare

Gitlab

  • https://gitlab.com/api/v4/projects/22287398/repository/files/spec3.json/raw?ref=master

Bitbucket

  • https://bitbucket.org/organiaztion/project/src/branch-name/src/path/to/the/file
  • https://bitbucket.org/organiaztion-name/project-name/src/commit-hash/src/path/to/the/file?at=main

SwaggerHub

--

--

Get the Medium app

A button that says 'Download on the App Store', and if clicked it will lead you to the iOS App store
A button that says 'Get it on, Google Play', and if clicked it will lead you to the Google Play store