OperationSpec interface
定義如何透過 HTTP 執行特定服務作業的規格,包括如何將要求資訊正確串行化,並將響應資訊還原串行化為 ServiceClient所傳回的物件承載。
屬性
base |
服務規格中提供的 URL。 這仍然會有其中所有的 URL 範本變數。 如果在建立 OperationSpec 時未提供此專案,則會由 ServiceClient 上的 “baseUri” 屬性填入。 |
content |
要求本文的內容類型。 如果提供此值,這個值將會當做“Content-Type” 標頭使用。 |
form |
作業方法的參數,將用來為作業的 HTTP 要求建立 formdata 主體。 |
header |
作業方法的參數,將轉換成作業 HTTP 要求上的標頭。 |
http |
這個作業的要求應該使用的 HTTP 方法。 |
isXML | 此作業是否使用 XML 要求和響應主體。 |
media |
要求本文的媒體類型。 如果提供,這個值可用來在串行化中提供這個值。 |
path | 此作業 URL 的固定路徑。 這仍然會有其中所有的 URL 範本變數。 |
query |
將新增至建構 URL 查詢之作業方法的參數。 |
request |
將用來建構 HTTP 要求主體的參數。 |
responses | 根據傳回的狀態代碼,此作業可以傳回的不同回應類型。 |
serializer | 要在此作業中使用的串行化程式。 |
url |
將取代為建構 URL 之作業方法的參數。 |
屬性詳細資料
baseUrl
服務規格中提供的 URL。 這仍然會有其中所有的 URL 範本變數。 如果在建立 OperationSpec 時未提供此專案,則會由 ServiceClient 上的 “baseUri” 屬性填入。
baseUrl?: string
屬性值
string
contentType
要求本文的內容類型。 如果提供此值,這個值將會當做“Content-Type” 標頭使用。
contentType?: string
屬性值
string
formDataParameters
作業方法的參數,將用來為作業的 HTTP 要求建立 formdata 主體。
formDataParameters?: readonly OperationParameter[]
屬性值
readonly OperationParameter[]
headerParameters
作業方法的參數,將轉換成作業 HTTP 要求上的標頭。
headerParameters?: readonly OperationParameter[]
屬性值
readonly OperationParameter[]
httpMethod
isXML
此作業是否使用 XML 要求和響應主體。
isXML?: boolean
屬性值
boolean
mediaType
要求本文的媒體類型。 如果提供,這個值可用來在串行化中提供這個值。
mediaType?: string
屬性值
string
path
此作業 URL 的固定路徑。 這仍然會有其中所有的 URL 範本變數。
path?: string
屬性值
string
queryParameters
將新增至建構 URL 查詢之作業方法的參數。
queryParameters?: readonly OperationQueryParameter[]
屬性值
readonly OperationQueryParameter[]
requestBody
responses
根據傳回的狀態代碼,此作業可以傳回的不同回應類型。
responses: {[responseCode: string]: OperationResponse}
屬性值
{[responseCode: string]: OperationResponse}
serializer
urlParameters
將取代為建構 URL 之作業方法的參數。
urlParameters?: readonly OperationURLParameter[]
屬性值
readonly OperationURLParameter[]