WADL2JAVA 指令
wadl2java 指令行工具會處理現有的「Web 應用程式說明語言 (WADL)」檔,並產生開發 Java™ API for RESTful Web Services (JAX-RS) Web 服務應用程式所需要的構件。 wadl2java 指令行工具支援使用由上而下方法來開發 JAX-RS Web 服務。當您開始使用現有的 WADL 檔時,請利用 wadl2java 指令行工具來產生必要的 JAX-RS 構件。
Web 應用程式說明語言 (WADL)
WADL 是一個以資源為中心的說明語言,其設計旨在協助建模、說明和測試 RESTful Web 應用程式。如需相關資訊,請參閱 Web 應用程式說明語言。語法
指令語法如下:
wadl2java --[options]
wadl2java -wadlns wadl-namespace -p package-name -sp [schema-namespace =]package-name -tMap schema-type=java-type * -repMap media-type=class-name * -resource resource-name -b binding-file-name * -catalog catalog-file-name -d output-directory -interface -impl -async methodNames * -generateEnums -inheritResourceParams -noTypes -noVoidForEmptyResponses -noAddressBinding -supportMultipleXmlReps -generateResponseIfHeadersSet -generateResponseForMethods methodNames * -async methodNames * -xjc xjc-argumentsv * -encoding encoding -h|-?|-help -version|-v -verbose|-V -quiet|-q|-Q wadl
參數
wadl2java 指令可使用的 options 值如下:
- -wadlns wadl-namespace
- 指定 WADL 名稱空間。
- -p package-name
- 當產生的程式碼代表 WADL 資源元素時,指定其要使用的 Java 套件名稱。
- -sp [schema-namespace =]package-name
- 當產生的程式碼代表 WADL 文法元素時,指定其要使用的 Java 套件名稱。您可以選擇性地指定 Java 套件名稱對映的名稱空間。
- -tMap schema-type=java-type *
- 指定 WADL 參數或表示法綱目類型與自訂 Java 類型之間的選用對映。
- -repMap media-type=class-name *
- 指定沒有 wadl:element 屬性之 WADL 表示法與 Java 類別之間的選用對映。
- -resource resource-name
- 當產生的程式碼代表沒有 id 屬性的 WADL 資源時,指定其要使用的簡式類別名稱。
- -b binding-file-name *
- 指定外部 jaxb 連結檔。對於每一個連結檔,請分別使用一個 -b 旗標。
- -catalog catalog-file-name
- 指定要對映所匯入之 wadl 或綱目的型錄檔。
- -d output-directory
- 指定用來放置程式碼的目錄。
- -interface
- 指定產生介面。
- -impl
- 指定產生虛擬服務實作。
- -async methodNames *
- 指定需要支援暫停的非同步呼叫的方法名稱或 ID 清單,並以逗點區隔。
- -generateEnums
- 指定可以產生 Enum 類別,以代表含有多個選項的參數。
- -inheritResourceParams
- 指定資源層次(路徑或矩陣)參數可讓子項資源繼承。
- -noTypes
- 關閉產生類型
- -noVoidForEmptyResponses
- 將 JAX-RS Response 傳回類型用於沒有回應表示法的方法。
- -noAddressBinding
- 指定產生器可能不會使用位址 jaxb 連結檔,來將 wsa:EndpointReferenceType 或 wsa:EndpointReference 對映至 javax.xml.ws.wsaddressing.W3CEndpointReference。
- -supportMultipleXmlReps
- 指定如果方法含有多項要求 XML 表示法,則為這類表示法一一產生個別的方法。當產生伺服器端 JAX-RS 程式碼時,請勿啟用這個選項。含有 javax.xml.transform 的單一方法。依預設,在這類情況下,會產生來源輸入參數。
- -generateResponseIfHeadersSet
- 如果 WADL Response 元素具有 'header' 參數,請使用 JAX-RS Response 傳回類型。
- -generateResponseForMethods methodNames *
- 指定需要產生 JAX-RS Response 傳回類型的方法名稱或 ID 清單,並以逗點區隔。
- -async methodNames *
- 指定需要支援暫停的非同步呼叫的方法名稱或 ID 清單,並以逗點區隔。
- -xjc xjc-argumentsv *
- 指定當使用 JAXB 資料連結時,要直接傳遞給 XJC 的引數清單,並以逗點區隔。這個選項會使 XJC 載入額外的外掛程式,來擴增程式碼的產生。舉例來說,為了載入 toString(ts) 外掛程式,以便將 toString() 方法新增至所有產生的類型,使用了下列的 arguments:-xjc-Xts。使用 -xjc-X,可以取得可用的 XJC 外掛程式清單。
- -encoding encoding
- 指定當產生 Java 原始檔時,要使用的字集編碼。
- -h|-?|-help
- 顯示選項的詳細資訊。
- -version|-v
- 顯示工具的版本。
- -verbose|-V
- 指定產生器以詳細模式執行。
- -quiet|-q|-Q
- -quiet|-q|-Q
- wadl
- wadl-url