Documentación API RESTful [cerrado]
Pronto voy a diseñar una API REST, por lo que debo describirla para que otras personas puedan comenzar a implementar los clientes que la utilizan.
He mirado alrededor un poco, pero desafortunadamente, no he encontrado ninguna forma estandarizada de describir los servicios RESTful basados en la web. Lo que estoy buscando es algo como JavaDoc, aunque no tiene que generarse a partir de ningún tipo de código. Tampoco estoy hablando de algo como WADL, más bien quiero tener alguna documentación legible por humanos que pueda entregar.
Debido a la naturaleza de los servicios basados en web RESTful, debería ser bastante fácil estandarizar una documentación. Solo debe enumerar los recursos disponibles, los URI correspondientes, los métodos permitidos, los tipos de contenido y describir las acciones disponibles. ¿Tienes alguna sugerencia por lo tanto?
Gracias de antemano y saludos