We need a tool documenting our public REST API (ASP.NET Web API 2.0), and I've been looking for informations about whether or not Confluence is a good choice for this task.
While it would be nice if the documentation could be autogenerated from our source code, or from a swagger specification, it's not a strict requirement.
Does anyone have any experience writing REST API documentation style in Confluence? Are there any specific templates with a fit layout, or how do you write your documentation?
I am quite late to this question, but I stumbled across this question via search, and others may in the future as well. I recently had this issue myself, and after finding no good out of the box solutions to integrate Swagger with Confluence, I wrote a library called Swagger Confluence.
If you document your REST API with Swagger as you suggested, and you would like a copy of the API documentation in Confluence, this project will automate your ability to do that. I wrote it for Java + Gradle, but I also provided a Command Line version that should be embeddable into any language / tool.
Using the library, you could make it publish updated documentation to Confluence as part of a Continuous Integration or deployment process, for example. Since it is written in Java, you would need to run the publisher with Java, but you could use it with any language as long as you have a Swagger schema.
On the linked homepage, there is a live demo that shows several available display options.
Note: For Confluence Cloud in particular, you need to make sure the REST API is enabled for your instance For stand-alone Confluence, this is enabled by default. The library works via the REST API so it will fail if the API is not available.
Full disclosure: I am the author of the library; I wrote it after having a similar problem myself. I released it as open source software in hope that it would be useful to others.
Thank you so much for sharing this. Was exactly what I was looking for.
I expect to make some tweaks, since I want to use page properties for all routes so I can have an overview page with all routes on them for brevity.
But this beats having to implement it all from scratch.
Me too. A few things I've found:
I'm using Confluence Server though, and I'd prefer to edit within Confluence.
Still waiting on Atlassian Marketplace approval, I'm afraid.
From previous experience, approval normally takes between 1-2 weeks.
The server version of Confluence Open API Documentation was submitted on May 17; so it has been just over two weeks in pending approval status, which hopefully means it should be any day now.
- Create your own custom emoji 🔥 - "Shake for Feedback" on mobile 📱 - An endless supply of GIFs via GIPHY 🤩 Is there anything quite as nice as a pleasant surprise? Comment below with what...
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