We are happy to announce an update to the Bitbucket Cloud 2.0 REST API, designed to offer developers a more robust and consistent experience building Bitbucket Cloud integrations. And while we've improved the API and its documentation to make for a smoother integration experience, we're most excited for you to try the changes we've made to Bitbucket Connect and the API Proxy. It's now easier than ever to build efficient and performant apps for Bitbucket Cloud.
Bitbucket Query Language (BBQL) is a generic querying language you can use to filter results from Bitbucket. With BBQL you can configure your Bitbucket integrations to request and handle only the specific data that matters to you. Different but related is the ability to query for partial responses, since this lets you be explicit about what fields you do or don't want included in the response. These methods for filtering response data aren't only useful for trimming down the data returned to your application, they also improve the time taken to process the request in Bitbucket thanks to lazy evaluation of the data being returned. If you're familiar with GraphQL, you'll find that the combination of BBQL and partial responses brings a lot of that power and flexibility to plain REST endpoints.
Good APIs need good documentation, so we spent time addressing the gaps and inconsistencies we found in our developer documentation with this update. Our new API documentation is built on top of the Open API Specification 2.0 (formerly Swagger), and as an Open API member organization, we built and released the RADAR doc generator tool for rendering documentation written according to this specification. Our updated documentation offers a more thorough and understandable overview of what endpoints are available and how they work.
Check out the new documentation for:
New to Bitbucket Cloud, the API proxy module creates a layer between your API and Bitbucket to provide the heavy lifting for critical services like authentication and parameter substitution (among others). Another huge benefit of using the proxy module is taking advantage of response object hydration, which allows remote services to keep track of only the absolute minimum information to uniquely identify an object stored in Bitbucket. The API proxy module should make the API integrations and apps you build into Bitbucket Cloud more efficient and easier to build. We've also published an API proxy module guide to help get you started using the proxy module. Be sure to check it out.
The API proxy module will make it easier and more efficient to build apps and API integrations into Bitbucket Cloud.
Like everything we build at Atlassian, we depend on feedback from our integrations partners. Tell us what's working, what's missing, or where we can improve by leaving us some feedback in the Atlassian Developer Community.