在CXF中公開RAML合同而不是WADL

Question

我是REST世界的新手，在大多數CXF示例中，我看到有一種配置，用於在發布時在REST服務中公開WADL。

就像是

Available RESTful services:
Endpoint address: http://localhost:8080/ouat-servicesImpl/api
WADL : http://localhost:8080/ouat-servicesImpl/api?_wadl

然后，當點擊

<application>
  <grammars/>
  <resources base="http://localhost:8080/ouat-servicesImpl/api">
    <resource path="/topics">
      <method name="POST">
        <request>
          <representation mediaType="application/json"/>
        </request>
        <response>
          <representation mediaType="application/json"/>
        </response>
      </method>
    </resource>
  </resources>
</application>

我正在學習RAML及其在合同創建中的好處。 有什么方法可以在此CXF“主頁”服務頁面中公開RAML合同嗎？ 還是我混用了RAML和WADL的概念/目的？ 實際上，我認為這兩種都是公開服務合同的方式，但是我認為RAML更完整

Answer 1

假設您將CXF服務打包為WAR，則根據我正在從事的真實項目，這是實現目標的方法：

• 將RAML和JSON文件拖放到webroot文件夾下： https : //github.com/openanalytics/RPooli/tree/master/webapp/src/main/webapp/raml
• 模板baseUri以便可以在運行時注入： https : //github.com/openanalytics/RPooli/blob/master/webapp/src/main/webapp/raml/api_v1.raml#L21
• 聲明.raml就像是JSP一樣，以便注入可以正常工作： https : //github.com/openanalytics/RPooli/blob/master/webapp/src/main/webapp/WEB-INF/web.xml#L70
• 添加RAML MIME類型： https : //github.com/openanalytics/RPooli/blob/master/webapp/src/main/webapp/WEB-INF/web.xml#L76-L79
• 添加一個過濾器以計算baseUri的動態部分： https : //github.com/openanalytics/RPooli/blob/master/webapp/src/main/java/eu/openanalytics/rpooli/web/BaseUriInjectionFilter.java
• 將其連接到web.xml： https : //github.com/openanalytics/RPooli/blob/master/webapp/src/main/java/eu/openanalytics/rpooli/web/BaseUriInjectionFilter.java

獎勵積分：

• 嵌入RAML API控制台： https : //github.com/openanalytics/RPooli/tree/master/webapp/src/main/webapp/raml/ui
• 並從Web應用程序主頁重定向到它： https : //github.com/openanalytics/RPooli/blob/master/webapp/src/main/webapp/index.html