2012-01-15 17 views
5

Symfony projesinden doğrudan REST API için dokümanlar oluşturmanın kolay bir yolu var mı?Otomatik oluşturmak Symfony'den REST API belgeleri

+0

Symfony hangi sürümünü kullanıyorsunuz? – MrGlass

+0

Symfony 2 –

+0

kullanıyoruz Bunu otomatik olarak yapmanın bir yolu olduğunu düşünmüyorum. Çoğu şeyin yönlendirmede tanımlanması gerekir, ancak bu Belgeler için uygun olmaz. – MrGlass

cevap

9

Posta kazımı için özür dilerim, ancak API doc nesline yardımcı olacak bir Symfony paketi var, FOSRestBundle ile iyi bağlanan NelmioApiDocBundle'u kontrol edebilirsiniz.

FOSRestBundle belgeleri, REST-ful web hizmetleri ve belgelerini oluşturmak için her iki paketi de kullanarak örnek paketler sağlar.

+0

parametre türlerini belgelemenin bir yolu var mı Nelmio'da (ör: form-data vs raw json vs)? [burada] (https://github.com/nelmio/NelmioApiDocBundle/issues/403) – abbood

+0

Bu özel kullanım durumu için açıklamayı kullanmanız gerektiğini söyleyebilirim. İşaretlemede biçimlendirebilirsiniz. –

+0

Ek açıklamaları oluşturmanın herhangi bir yolu var mı? – dustfeather