2013-03-09 10 views
7

Przez całą noc szukałem klejnotu, aby wygenerować dokumentację API z moich tras Sinatra. Powinienem móc określić za pomocą wstawianych komentarzy.Sinatra zbudować dokumentację API REST

znalazłem https://rubygems.org/gems/sinatra-api-docs & https://rubygems.org/gems/sinatra-croon

ale zarówno po prostu nie wydają się działać z mojej konfiguracji są przestarzałe i zbyt ..

Drugą opcją było podwórko z jakimś Sinatra wtyczki, ale to nie robi wygenerować specjalny układ interfejsu REST API podczas generowania dokumentów.

Czy ktoś ma jakieś narzędzia, o których wie?

Wszystkie informacje chcę odniesienia dla każdej trasy:

obiektu: Grupy

Trasa: POST/tworzyć

Params: Nazwa grupy

wyjściowa:

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

dzięki

Odpowiedz

1

Sprawdziłbym, czy nie jest to Apiary.io, wygląda całkiem dobrze i używa języka specyficznego dla Markdown, aby opisać twój interfejs API. Plus za darmo, gdy jest jeszcze w wersji beta.

1

Czy wypróbowałeś ? Użyłem go, z pewnymi modyfikacjami na Yardzie, do tworzenia moich dokumentów API.