Create
cancel
Showing results for 
Search instead for 
Did you mean: 
Sign up Log in
It's not the same without you

Join the community to find out what other Atlassian users are discussing, debating and creating.

Atlassian Community Hero Image Collage

How to create Request and Response template like Confluence Developers page?

Hello Folks! I wonder if I can create an example of request and response in my confluence page like Confluence Developers Guide page has: https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-users/#api-rest-api-2-user-get

image.png

2 answers

1 accepted

2 votes
Answer accepted
Darryl Lee Community Leader Dec 05, 2021

I'm pretty sure that https://developer.atlassian.com/ is not hosted on Confluence. Or more specifically the API reference pages. I can't quite figure out whether it's a product or home-grown. 

So, while you could get some of the tab functionality using add-ons like @Dave Liao noted, I thought you might be looking for a more complete solution that can generate API request/response examples directly from specs/documentation that is checked-in alongside code.

As I suspected, that kind of functionality is built on proprietary code that Atlassian has written:

Is the Rest API documentation tool used by Atlassian Open-source?

Unfortunately not yet. The developer.atlassian.com team wrote it all in React and it’s based, directly, on OpenAPI spec files. We even wrote the schema explorer from scratch. We also make good use of oas-kit and react-markdown.

If you are looking for a way to do something similar to this within Confluence, there are several apps that will allow you to include Swagger / OpenAPI documentation on your Confluence site:

Anyways, hope this helps.

Like Dave Liao likes this
1 vote
Dave Liao Community Leader Dec 06, 2021

@Danilo de Nadai Sicari - hi Danilo!

There are various tab add-ons on the Marketplace that could replicate what's seen on Atlassian's Developer site.

Suggest an answer

Log in or Sign up to answer
DEPLOYMENT TYPE
CLOUD
PRODUCT PLAN
STANDARD
TAGS
Community showcase
Published in Confluence Cloud

🏠 Say hello to the new Confluence Home!

Hi Atlassian Community, My name is DJ Chung, and I’m a Product Manager on the Confluence Cloud team. Today, I’m excited to share a new and improved version of Home. The new Home helps you ...

43,894 views 33 137
Read article

Community Events

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

Find an event

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

Unfortunately there are no Community Events near you at the moment.

Host an event

You're one step closer to meeting fellow Atlassian users at your local event. Learn more about Community Events

Events near you