Göreceli olarak büyük bir REST API yapısına sahip olmamız, Play 2.x'in üst kısmındadır ve dahili kullanıcılarımız için belgelendirmekle görevlendirilmiştir. Bunu ayrı bir wiki üzerinde sürdürmenin çok zor olduğu inancımız olduğundan, Play için herhangi bir doküman oluşturma aracı olup olmadığını merak ediyoruz.Play 2.x için API belgelerini oluşturmak için herhangi bir eklenti var mı?
Play.current.routes.foreach(r => println(r.documentation))
Swagger 2 Play desteği sağlar Oyna 2.4, yönlendiriciyi enjekte edersiniz:
Ancak, bu gerçekten iyi bir API belgesi değildir. Almazsınız, POST'a ne tür şeyleriniz vardır, ya da hangi maddeleri alırsınız. oyun dışı bir REST API belgelerini almak için daha iyi bir yol var ist eğer ben şimdi Raml kullanıyorum
sanırım içinde: dediğiniz şey ne olur 2 kendisinin uygun bir biçimde kendi yönlendiriciye belgeler sağlar
https://github.com/swagger-api/swagger-play
Çal, ödeme:
Hala ..., merak. http://raml.org/
Otomatik API belge üretme yoktur. API dokümanlarını elle oluşturmanız ve değiştirmeniz gerekir, ancak bu hiç de fena değildir. Elbette, eğer api'nizi değiştirirseniz, api belgesini de değiştirmeyi unutmayın; Bu bir başarısızlık noktasıdır.
Ancak bu iyi: Kodunuzu ek açıklamalarla ve API belge yorumlarıyla kirletmezsiniz. Bu benim için en önemli nokta. "API doc dili" öğrenmek/kullanmak gerçekten çok kolay.
GitHub bağlantı çalışmıyor! – Sivakumar