OperationSpec interface
En specifikation som definierar en åtgärd.
Egenskaper
| base |
Url:en som angavs i tjänstens specifikation. Detta kommer fortfarande att ha alla URL-mallvariabler i sig. Om detta inte anges när OperationSpec skapas fylls den i av en "baseUri"-egenskap på ServiceClient. |
| content |
Innehållstypen för begärandetexten. Det här värdet används som rubriken "Innehållstyp" om det anges. |
| form |
Parametrarna för den åtgärdsmetod som ska användas för att skapa en formulärdatatext för åtgärdens HTTP-begäran. |
| header |
Parametrarna till den åtgärdsmetod som ska konverteras till rubriker på åtgärdens HTTP-begäran. |
| http |
DEN HTTP-metod som ska användas av begäranden för den här åtgärden. |
| isXML | Oavsett om den här åtgärden använder XML-begärande- och svarsorgan. |
| media |
Medietypen för begärandetexten. Det här värdet kan användas för att hjälpa till med serialisering om det anges. |
| path | Den fasta sökvägen för den här åtgärdens URL. Detta kommer fortfarande att ha alla URL-mallvariabler i sig. |
| query |
Parametrarna för den åtgärdsmetod som ska läggas till i den konstruerade URL:ens fråga. |
| request |
Parametern som ska användas för att konstruera HTTP-begärans brödtext. |
| responses | De olika typer av svar som den här åtgärden kan returnera baserat på vilken statuskod som returneras. |
| serializer | Serialiseraren som ska användas i den här åtgärden. |
| url |
Parametrarna till den åtgärdsmetod som ska ersättas med den konstruerade URL:en. |
Egenskapsinformation
baseUrl
Url:en som angavs i tjänstens specifikation. Detta kommer fortfarande att ha alla URL-mallvariabler i sig. Om detta inte anges när OperationSpec skapas fylls den i av en "baseUri"-egenskap på ServiceClient.
baseUrl?: string
Egenskapsvärde
string
contentType
Innehållstypen för begärandetexten. Det här värdet används som rubriken "Innehållstyp" om det anges.
contentType?: string
Egenskapsvärde
string
formDataParameters
Parametrarna för den åtgärdsmetod som ska användas för att skapa en formulärdatatext för åtgärdens HTTP-begäran.
formDataParameters?: readonly OperationParameter[]
Egenskapsvärde
readonly OperationParameter[]
headerParameters
Parametrarna till den åtgärdsmetod som ska konverteras till rubriker på åtgärdens HTTP-begäran.
headerParameters?: readonly OperationParameter[]
Egenskapsvärde
readonly OperationParameter[]
httpMethod
DEN HTTP-metod som ska användas av begäranden för den här åtgärden.
httpMethod: HttpMethods
Egenskapsvärde
isXML
Oavsett om den här åtgärden använder XML-begärande- och svarsorgan.
isXML?: boolean
Egenskapsvärde
boolean
mediaType
Medietypen för begärandetexten. Det här värdet kan användas för att hjälpa till med serialisering om det anges.
mediaType?: string
Egenskapsvärde
string
path
Den fasta sökvägen för den här åtgärdens URL. Detta kommer fortfarande att ha alla URL-mallvariabler i sig.
path?: string
Egenskapsvärde
string
queryParameters
Parametrarna för den åtgärdsmetod som ska läggas till i den konstruerade URL:ens fråga.
queryParameters?: readonly OperationQueryParameter[]
Egenskapsvärde
readonly OperationQueryParameter[]
requestBody
Parametern som ska användas för att konstruera HTTP-begärans brödtext.
requestBody?: OperationParameter
Egenskapsvärde
responses
De olika typer av svar som den här åtgärden kan returnera baserat på vilken statuskod som returneras.
responses: {[responseCode: string]: OperationResponseMap}
Egenskapsvärde
{[responseCode: string]: OperationResponseMap}
serializer
Serialiseraren som ska användas i den här åtgärden.
serializer: Serializer
Egenskapsvärde
urlParameters
Parametrarna till den åtgärdsmetod som ska ersättas med den konstruerade URL:en.
urlParameters?: readonly OperationURLParameter[]
Egenskapsvärde
readonly OperationURLParameter[]