hkamel / azuredevops-postman-collections

The collections allow you to test common Azure DevOps Rest APIs from within Postman.

Azure DevOps Postman Collections

Inspired by @Jeremy Thake's Microsoft Graph Collection

The collections allows you to test common Azure DevOps Rest APIs from within Postman.

Setup

To setup the Postman collections follow these steps:

1. Download and register for Postman from their website or from chocolatey.org.

2. Click File | Import ....

3. Select Import From Link.

4. Paste the following two URLs and click Import after each.

   https://raw.githubusercontent.com/hkamel/azuredevops-postman-collections/master/Azure%20DevOps%20v5.0.postman_collection.json

   https://raw.githubusercontent.com/hkamel/azuredevops-postman-collections/master/Azure%20DevOps%20Environment.postman_environment.json

   You should now see the Azure DevOps v5.0 collection on the left had side Collections pane.

5. Click on the No environment drop down in top right hand corner.

6. Select Azure DevOps Environment.

7. Click the eye icon to the the right and then click Edit.

8. Enter in to the current (not initial) variables your Azure DevOps organization name: Organization, AccessToken ad Api-version.

   • By default, the requests will go to the cloud hosted Azure DevOps. If you want to use it for an on-prem instance, change the coreServer URL and then update feedServer, graphServer and releaseServer as required. If they are all the same, you can update coreServer and then update the others to {{coreServer}}

9. Select Update. Close the Manage Environments dialog.

   IMPORTANT: It is not recommended to use production user accounts as this information is stored directly in Postman. This is also not a recommended approach for obtaining access tokens in production and should only be used for testing purposes.

10. Expand the Core | Projects folder and click on List all projects. Then Click the Send button.

You are now up and running with Azure DevOps postman collections.

Contribute

You can contribute to this project by forking the repo and following the setup steps to import those files. When you've made your contributions in Postman editor, use the File | Export to overwrite the file in your forked branch. Then simply submit the forked branch as a PR back to this repo.

azuredevops-postman-collections's Issues

Missing comma in environment.json leads to failing import

azuredevops-postman-collections/Azure DevOps Environment.postman_environment.json

Line 141 in 80d3067

"description":""

Suggestion: Add support for "Get File Contents"

Thanks for all of your hard work on this!

One suggestion would be to add support for the following function: Get File Contents

Feature Request: Git- Commits APIs

Add Git- Commits APIs

• Get | Retrieve a particular commit.
• Get Changes | Retrieve changes for a particular commit.
• Get Commits | Retrieve git commits for a projectParameters that use the searchCriteria prefix in their name can be specified without it as query parameters, e.g. searchCriteria.$top -> $top
• Get Commits Batch | Retrieve git commits for a project matching the search criteria
• Get Push Commits | Retrieve a list of commits associated with a particular push.

https://docs.microsoft.com/en-us/rest/api/azure/devops/git/commits?view=azure-devops-rest-5.1

Any idea on updating to v6.0 or even 6.1.preview.1 ?

Suggestion: Replace authorization on each request with inherited auth from parent collection

Each of these requests has the same Authorization setting - basic auth with the AccessToken password. To make it easier to add new requests to the collection, I'd suggest setting the Authorization at the collection level and having all requests inherit from the parent.

I'd be willing to do this if you're ok with it.

Not an issue, small query on the API testing

New to the field of Azure devops, so I started to test the API using postman manually. I am planning to do the API service testing automatically and create pipeline in azure devops. So how do i integrate the postman API's in azure devops pipeline. Can anyone help me on this please.

Feature Request: Git- Repositories APIs

Add Git- Repositories APIs

• Create| Create a git repository in a team project.
• Delete | Delete a git repository
• Delete Repository From Recycle Bin | Destroy (hard delete) a soft-deleted Git repository.
• Get Deleted Repositories | Retrieve deleted git repositories.
• Get Recycle Bin Repositories | Retrieve soft-deleted git repositories from the recycle bin.
• Get Repository | Retrieve a git repository.
• Get Repository With Parent | Retrieve a git repository.
• List | Retrieve git repositories.
• Restore Repository From Recycle Bin | Recover a soft-deleted Git repository. Recently deleted repositories go into a soft-delete state for a period of time before they are hard deleted and become unrecoverable.
• Update| Updates the Git repository with either a new repo name or a new default branch.

https://docs.microsoft.com/en-us/rest/api/azure/devops/git/repositories?view=azure-devops-rest-5.1