Resteasy - DİNLENME Javadoc belgelere ve ben java kod dışarı güzel REST API belgelerine (WadL veya HTML) oluşturmak için bir yol bulmak istiyoruz

Question

Ek Açıklamalar üretmek - JAXB dayalı JAX-RS ek açıklamaları ve java doc yorumlar (hayır doclet Lütfen). İşte

projemin ortamı

• Bahar, hiçbir yalnızca XML DİNLENME sağlayıcının JSON
rest API için
• JAXB ve JAX-RS ek açıklamaları
• Mime Tipi olarak
• istirahat kolay ek notların olduğu

Answer 1

Enunciate ürününü deneyin.

Enunciate, Java Web hizmeti API'nizi önemli ölçüde geliştiren bir motordur. Bu basit. Standart Java teknolojilerini kullanarak Web hizmeti API'nizi geliştirirsiniz ve oluşturma işleminize Enunciate ekleyin. Aniden, Web servis API'niz oldukça etkileyici bazı özelliklere sahip:

• Hizmetlerinizin tam HTML belgeleri, JavaDocs'ınızdan not alın. API'nızla arabirim kurmak isteyen geliştiriciler için istemci tarafı kitaplıkları (ör. Java, .NET, iPhone, Ruby, Flex, AJAX, GWT, vb.).
• Arayüzü Tanımı Belgeler (vs. örneğin WSDL, WadL, XML şema,) Enunciate alternatif olarak
• Vb

Answer 2

Java derleyicisi API'leri Java kaynağını ayrıştırır kod yazmak ve kendi işlem gerçekleştirmek için izin verir.

Ek açıklamalara ayrıştırma hakkında bilgiler içeren bir instructional article, bu.

Ben size bu API'leri kullanarak gerek ham bilgiyi çıkarabilir tahmin. Ancak bu, sözdizimsel gerçekleri - REST URL'lerini ve eylemlerini ve parametrelerini üretecek - bir kullanıcı, servis yazıcısının Java Doc'ta sunabileceği (yapması gereken) ek açıklamadan da yararlanacaktır.

tam çözüm hem açıklama ve java doc ayrıştırmak ve ikisini birleştirmek olabilir.

Answer 3

, ayrıca MireDot düşünebilirsiniz. Kendi şirketimizde kullandığımız bir araçtan büyüdü ve açık kaynak projeleri için kullanmakta serbesttir. Tanımladığınız şeyi tam olarak yapar: jaxrs ek açıklamalarını ve mevcut javadoc yorumlarını bir dinlenme api oluşturmak için birleştirir. Sadece projenize eklemek zorunda olduğunuz bir maven eklentisi olarak çalışır. Jaxb ek açıklamaları henüz yazma aşamasında desteklenmez, ancak araç aktif geliştirme aşamasındadır ve önerileri/istekleri/geri bildirimleri temel alarak uygulamak için özellikleri seçeriz.