2

The RESTful Web service APIs are implemented using Restlet. I need to generate the API documentation for these. Rather than starting with a separate document, I am evaluating if this can be generated from the source code annotations itself.

I looked at Swagger and enunciate. Swagger seems to be based on the JAX-RS specification. Enunciate looked a little more promising as there is an FAQ that mentions how to generate for non JAX-RS implementations but there is no help.

  1. Are there any tools (or if the community has used any) for generating API documentation from Restlet annotations?

  2. Has anyone integrated Restlet with enunciate for generating documentation?

Improve this question
3
  • Was about to start on something just like this. Was wondering if you had found a solution? Have you investigated the WADL extension (wiki.restlet.org/docs_2.0/13-restlet/28-restlet/72-restlet.html)? Commented Dec 11, 2012 at 5:18
  • I could not find anything suitable which could be integrated. I did try enunciate but could not get it to work to only generate documents due to conflicting annotations. I finally used Sphinx and created a nice document. Commented Dec 11, 2012 at 11:35
  • Some work has been done on a Swagger extension for Restlet: github.com/restlet/restlet-framework-java/issues/595 Commented Feb 2, 2014 at 20:40

1 Answer 1

Reset to default
1

Restlet now supports the ability to generate either corresponding Swagger and RAML contents based your application at runtime.

Following docs could help you:

You can then leverage tools from the tool community to generate your API documentation. You could consider Swagger UI that is a great tool to display online what an API provides and interact with it.

Hope it helps you, Thierry

Improve this answer
Sign up to request clarification or add additional context in comments.

Comments

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service and acknowledge you have read our privacy policy.

Start asking to get answers

Find the answer to your question by asking.

Ask question

Explore related questions

See similar questions with these tags.