Swagger Description for JIRA

I'm looking for the swagger.json (OpenAPI) files for JIRAs REST API. I have found the documentation which using RADAR was generated from it, but I really need the json definition instead. Bitbucket exposes it but I'm unable to find JIRAs at all. Can someone please provide a link to it?

4 answers

0 votes

Hi Edward,

It look like that is generated from an add-on for Confluence called the Open API Documentation for Confluence.  I checked and they do not have an add-on for JIRA.

I see that Bitbucket exposes it in the API, however, looking at the JIRA API I do not see a path that provides swagger.json output.

You can create a Suggestion to have this added to JIRA at JAC.  If you do so please post the link to the ticket here so the community can vote on it and add impact.

Cheers,

Branden

Hello Branden


The  Open API Documentation for Confluence add-on takes a swagger.json file like the one I'm after and produces confluence documentation, much like RADAR does. For Atlassian to have produced their documentation using RADAR then they must have had a copy of that json file. I don't necessarily want it to be exposed as bitbuckets is, though that would certainly be lovely. Instead I'm aftet a one off copy of that json, wherever it may be. Pastebin, dropbox, I'm not fussy, but it definitely exists somewhere otherwise JIRAs documentation wouldn't exist.

Kind Regards

Ed

Hi Edward,

Here is a suggested route you might take...

Jira does provide a wadl description at https://docs.atlassian.com/jira/REST/server/jira-rest-plugin.wadl

so perhaps you can covert it into swagger.json via https://apimatic.io/transformer 

0 votes

tldr; https://developer.atlassian.com/cloud/jira/platform/swagger-v3.v3.json

Not sure if it was added recently as I'm new to Atlassian products in general but what you seek is currently hiding in plain sight.

Go to: https://developer.atlassian.com/cloud/jira/platform/rest/v3/

When the page loads, you'll see a subdued button with text "Run in Postman", and next to it another button with three dots. Clicking the three dots will pop a new tab and go to the link I've pasted at the top of this message.

Suggest an answer

Log in or Sign up to answer
Community showcase
Posted Sep 18, 2018 in Jira

What modern development practices are at the heart of how your team delivers software?

Hey Community mates! Claire here from the Software Product Marketing team. We all know software development changes rapidly, and it's often tough to keep up. But from our research, we've found the h...

22,708 views 2 7
Join discussion

Atlassian User Groups

Connect with like-minded Atlassian users at free events near you!

Find a group

Connect with like-minded Atlassian users at free events near you!

Find my local user group

Unfortunately there are no AUG chapters near you at the moment.

Start an AUG

You're one step closer to meeting fellow Atlassian users at your local meet up. Learn more about AUGs

Groups near you