Sinatra build REST API belgeleri

Question

Sinatra rotalarımdan bir API belgesi oluşturmak için tüm gece bir gem için arıyorum. Satır içi yorumlar ile belirtebilmeliyim.

Ben & https://rubygems.org/gems/sinatra-croon

https://rubygems.org/gems/sinatra-api-docs bulduk ama hem

Diğer seçenek bazı sinatra eklenti ile yarda oldu .. sadece benim kurulumu ile çalışmak için görünmüyor ve eskimiş çok, ama bu değil Dokümanları oluştururken REST API'sine özel düzen oluşturur.

Bildikleri herhangi bir araç var mı?

i her rota için başvurmak istiyorum tüm bilgiler:

Nesne: Gruplar

Rota:

: Adı grubunun

Çıktı ait: POST/

PARAMS oluşturmak

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

teşekkürler

Answer 1

Apiary.io'u inceliyordum, oldukça iyi tasarlanmış görünüyor ve API'nizi tanımlamak için Markdown stili etki alanına özgü bir dil kullanıyor. Ayrıca hala beta sürümünde ücretsiz.

Answer 2

Sinatra Yard'u denediniz mi? API dokümanlarımı üretmek için Yard için bazı değişikliklerle kullandım.