OperationSpec interface
Especificación que define cómo realizar una operación de servicio determinada a través de HTTP, incluido cómo serializar correctamente la información de solicitud en y deserializar la información de respuesta en una carga de objeto que devuelve ServiceClient.
Propiedades
base |
Dirección URL proporcionada en la especificación del servicio. Esto seguirá teniendo todas las variables de plantilla de dirección URL en ella. Si no se proporciona cuando se crea OperationSpec, se rellenará mediante una propiedad "baseUri" en ServiceClient. |
content |
El tipo de contenido del cuerpo de la solicitud. Este valor se usará como encabezado "Content-Type" si se proporciona. |
form |
Parámetros para el método de operación que se usarán para crear un cuerpo formdata para la solicitud HTTP de la operación. |
header |
Parámetros del método de operación que se convertirán en encabezados en la solicitud HTTP de la operación. |
http |
Método HTTP que deben usar las solicitudes para esta operación. |
isXML | Si esta operación usa o no cuerpos de solicitud y respuesta XML. |
media |
Tipo de medio del cuerpo de la solicitud. Este valor se puede usar para aide en la serialización si se proporciona. |
path | Ruta de acceso fija para la dirección URL de esta operación. Esto seguirá teniendo todas las variables de plantilla de dirección URL en ella. |
query |
Parámetros del método de operación que se agregarán a la consulta de la dirección URL construida. |
request |
Parámetro que se usará para construir el cuerpo de la solicitud HTTP. |
responses | Los diferentes tipos de respuestas que esta operación puede devolver en función del código de estado que se devuelve. |
serializer | Serializador que se va a usar en esta operación. |
url |
Parámetros para el método de operación que se sustituirán en la dirección URL construida. |
Detalles de las propiedades
baseUrl
Dirección URL proporcionada en la especificación del servicio. Esto seguirá teniendo todas las variables de plantilla de dirección URL en ella. Si no se proporciona cuando se crea OperationSpec, se rellenará mediante una propiedad "baseUri" en ServiceClient.
baseUrl?: string
Valor de propiedad
string
contentType
El tipo de contenido del cuerpo de la solicitud. Este valor se usará como encabezado "Content-Type" si se proporciona.
contentType?: string
Valor de propiedad
string
formDataParameters
Parámetros para el método de operación que se usarán para crear un cuerpo formdata para la solicitud HTTP de la operación.
formDataParameters?: readonly OperationParameter[]
Valor de propiedad
readonly OperationParameter[]
headerParameters
Parámetros del método de operación que se convertirán en encabezados en la solicitud HTTP de la operación.
headerParameters?: readonly OperationParameter[]
Valor de propiedad
readonly OperationParameter[]
httpMethod
Método HTTP que deben usar las solicitudes para esta operación.
httpMethod: HttpMethods
Valor de propiedad
isXML
Si esta operación usa o no cuerpos de solicitud y respuesta XML.
isXML?: boolean
Valor de propiedad
boolean
mediaType
Tipo de medio del cuerpo de la solicitud. Este valor se puede usar para aide en la serialización si se proporciona.
mediaType?: string
Valor de propiedad
string
path
Ruta de acceso fija para la dirección URL de esta operación. Esto seguirá teniendo todas las variables de plantilla de dirección URL en ella.
path?: string
Valor de propiedad
string
queryParameters
Parámetros del método de operación que se agregarán a la consulta de la dirección URL construida.
queryParameters?: readonly OperationQueryParameter[]
Valor de propiedad
readonly OperationQueryParameter[]
requestBody
Parámetro que se usará para construir el cuerpo de la solicitud HTTP.
requestBody?: OperationParameter
Valor de propiedad
responses
Los diferentes tipos de respuestas que esta operación puede devolver en función del código de estado que se devuelve.
responses: {[responseCode: string]: OperationResponse}
Valor de propiedad
{[responseCode: string]: OperationResponse}
serializer
Serializador que se va a usar en esta operación.
serializer: Serializer
Valor de propiedad
urlParameters
Parámetros para el método de operación que se sustituirán en la dirección URL construida.
urlParameters?: readonly OperationURLParameter[]
Valor de propiedad
readonly OperationURLParameter[]