(Dokümantasyon yetenekleri enunciate benzer) bir Symfony tabanlı REST API belgelemek için nasıl

2 Cevap php

Ben Symfony [symfony-project.org] çerçevesinde (yani PHP) yazılı bir REST tabanlı hizmeti varsa, herhangi bir iyi araçları / çerçeveler kodumu ayrıştırmak ve API belgeler üretecek ki orada var mı?

Java tabanlı çerçeve enunciate ne gerek benzer dokümantasyon yetenekleri vardır, burada bunun bir örneğini görebilirsiniz: http://enunciate.codehaus.org/wannabecool/step1/index.html.

Ancak ben elle tüm uç noktalarını, desteklenen formatlar, örnek çıktı vb kadar yazmaya gerek kalmadan benim için bu belgeleri yazınca bir şey sonra oldu, REST tabanlı hizmetler öncül kendini belli olması gerekiyordu anlamak

Teşekkürler

2 Cevap

Sen değil Swagger daha önce gördüm emin. Gerçekten şahsen bunun için kefil olamaz ama onlar, bir PHP compatible version var gibi görünüyor. PHP yorum yoluyla bazı ağır manuel dokümantasyon gerektirir gibi gözüküyor olsa da, enunciate karşılaştırılabilir bazı otomatik API belgelerine nesil yapar. Söyleniyor, ben manuel çaba aynı veya wiki sayfaları üzerinden kendi yapmak daha az olacağını düşünüyorum, ve çıkış çok, çok güzel.

Sadece bir Factoid olarak Enunciate has indefinite plans to eventually diğer platformlarda , but the relevant Jira ticket şu anda Open işe almak için sponsor bekleyen destek gibi görünüyor.

Kimden ENUNCIATE-356 Jira ticket:

Diğer dilleri destekleyen ilk adım Java modelinden enunciate modeli decouple etmektir. Bu çalışma ENUNCIATE-584 izlenir ve kaydedilir ediliyor. Ne yazık ki, çünkü ne kadar ağır araştırmak faz dışına asla. Iş için bir sponsor olduğu sürece, yakında her zaman o ağır yük alarak beklemiyoruz.


Edit:
Found a similar question where someone mentions a GitHub project dedicated to Swagger+Symfony2. This other question is the same, but no additional information.

Benim bilgi için ortam türleri belgeleri otomatikleştirmek için hiçbir yolu yoktur.

Eğer XHTML gibi bir ortam türü gibi bir web tarayıcısı kullanıyorsanız Google sitemap sizin kaynaklar arasındaki ilişkileri göstermek için bazı yararlı çıktı üretebilir.

etiketler