Take the 2-minute tour ×

I am in the process of writing my own RESTful API and want to document it as I go along. I was wondering if anyone has any recommendations for a tool that would help with the documentation process? I am not looking for something that will automatically generate documentation based on reading source code or anything big and robust.

I am really looking for some kind of HTML theme that would be useful for displaying the information well or even a wordpress theme that would layout the documentation nicely as I don't mind providing all the information.

Any recommendations?

share|improve this question
possible duplicate of Documenting a REST service –  user647772 Jul 25 '12 at 8:45
Its not a duplicate, I saw that question and the answers started heading in a totally different direction. I was just wondering if someone has come across a good HTML or wordpress template for laying out documentation. –  ackerchez Jul 25 '12 at 10:05
add comment

1 Answer

Some folks are writing the swagger-spec document manually, and using the swagger-ui as documentation. You can do this without server integration, and it makes for a pretty nice reference for your users.

UPDATE: I pushed a swagger sample which has no server integration, other than a web server as a container to the swagger UI and spec files. See the swagger-core no-server sample

share|improve this answer
This is really useful. Thanks! –  Ryan Jan 9 '13 at 19:07
add comment

Your Answer


