2012-01-15 14 views
5

C'è un modo semplice per generare documenti per REST api direttamente da un progetto Symfony?Genera automaticamente documenti API REST da Symfony

+0

Quale versione di symfony stai usando? – MrGlass

+0

Stiamo usando symfony 2 –

+0

Non penso che ci sia un modo per farlo automaticamente. La maggior parte delle cose dovrebbe essere definita nel routing, ma non funzionerebbe bene per la Documentazione. – MrGlass

risposta

9

Ci scusiamo per il post scavo, ma c'è un pacchetto Symfony per aiutare la generazione di documenti API, è possibile controllare NelmioApiDocBundle che interconnette bene con FOSRestBundle.

La documentazione di FOSRestBundle fornisce bundle di esempio utilizzando entrambi i bundle per generare servizi Web REST-full e la relativa documentazione.

+0

esiste un modo per documentare i tipi di parametri in Nelmio (es. form-data vs raw json etc)? vedi [qui] (https://github.com/nelmio/NelmioApiDocBundle/issues/403) – abbood

+0

Direi che devi usare la descrizione per questo caso d'uso specifico. Puoi formattarlo nel markdown. –

+0

Esiste un modo per generare anche le annotazioni? – dustfeather