Documentação da API RESTful [fechada]
Vou criar uma API RESTful em breve, portanto, preciso descrevê-la para permitir que outras pessoas comecem a implementar clientes usando-a.
Eu olhei em volta um pouco, mas infelizmente não encontrei nenhuma forma padronizada de descrever serviços REST baseados na web. O que estou procurando é algo como JavaDoc, embora não precise ser gerado a partir de qualquer tipo de código. Eu também não estou falando sobre algo como a WADL, eu prefiro ter alguma documentação legível que eu possa distribuir.
Devido à natureza dos serviços baseados na Web RESTful, deve ser muito fácil padronizar uma documentação. Deve apenas listar recursos disponíveis, URIs correspondentes, métodos permitidos, tipos de conteúdo e descrever as ações disponíveis. Você tem alguma sugestão, portanto?
Agradecemos antecipadamente e cumprimentamos