Documentazione API REST di Sinatra

Question

Ho cercato per tutta la notte una gemma per generare una documentazione API dalle mie rotte sinatra. Dovrei essere in grado di specificare con commenti in linea.

ho trovato https://rubygems.org/gems/sinatra-api-docs & https://rubygems.org/gems/sinatra-croon

ma entrambi non sembrano lavorare con il mio setup e sono obsolete troppo ..

L'altra opzione era cortile con alcuni plugin di Sinatra, ma che non lo fa genera un layout specifico dell'API REST durante la generazione dei documenti.

Qualcuno ha qualche strumento che conosce?

tutte le informazioni che desidera fare riferimento per ogni percorso:

oggetto: Gruppi

Percorso: POST/creare

Parametri: Nome del gruppo

uscita:

{ 
    "name": "group", 
    "members": [] 
} 

grazie

Answer 1

Vorrei verificare Apiary.io, sembra piuttosto ben progettato e utilizza un linguaggio specifico del dominio in stile Markdown per descrivere la tua API. Inoltre è gratis mentre è ancora in beta.

Answer 2

Hai provato Sinatra Yard? L'ho usato, con alcune modifiche a Yard, per produrre i miei documenti API.