2013年9月13日 星期五

RESTful API 文件產生器 Enunciate 輕鬆上手



接續上一篇"Restful JSON API 文件產生器整理",我最後選了Enunciate來當做Restful 的文件產生器,在使用上也實很簡單,只要在Maven 專案裡面增加以下的Depency

 
<dependency>
 <groupid>org.codehaus.enunciate</groupid>
 <artifactid>enunciate-jboss-rt</artifactid>
 <version>1.27</version>
</dependency>

 

(註:因為我的rest framework 是用jboss 的resteasy 所以選擇enunciate-jboss-rt,如果你是用其他的套件可以參考文件enuciate maven plugin)

然後在Maven Plugin 的地方加入


org.codehaus.enunciate
 maven-enunciate-jboss-plugin
    1.27
 
  true
  ${basedir}/src/main/resources/enunciate.xml
  enunciate
 
 
  
   install
    
     docs
    
   
   
    ${project.parent.basedir}/myproject-doc/docs
   
  
 

 

接下來只要每次run mvn install 就會自動產生文件在指定的位置,如我上面所指定的${project.parent.basedir}/myproject-doc/docs

產生的畫面如下圖所示:






有興趣的人還可以去客製化改ccs,而且Enunciate 這個plugin 最厲害的是還可以針對你的Restful API產生好幾種語言的Client,包含java php ruby



張貼留言