2013-09-05 26 views
38

Express.js kullanarak bir restAPI üzerinde çalışıyorum ve bir kullanıcının API tanımlarını görüntülemesine izin veren API belgeleri oluşturmanın bir yolu olup olmadığını merak ediyorum veya muhtemelen API çağrısı denemek?Node.js veya Express.js REST API belge üreticisi

cevap

24

Swagger, otomatik API oluşturma belgeleri için harika bir projedir. Bir Express modülü içerir. Ne arıyorsun iyi bir JavaScript belgelerine jeneratör

https://developers.helloreverb.com/swagger/

https://github.com/wordnik/swagger-node-express

+0

Teşekkür @dankohn:

Ben henüz tam içine baktı umut verici görünüyor ki henüz burada bir çift daha bulundu. Ben kontrol ediyorum. –

+9

Bu otomatik üretim, ekspresde yapılandırılmış rotalara dayanır mı? – lostintranslation

+0

@lostintranslation AFAIK yapmıyorlar. Swagger belgeleri yml dosyalarına kaydedilir. – BillyTom