OperationSpec interface
Spesifikasi yang menentukan cara melakukan operasi layanan tertentu melalui HTTP, termasuk cara membuat serialisasi informasi permintaan dengan benar ke dalam dan mendeserialisasi informasi respons ke dalam payload objek yang dapat dikembalikan oleh ServiceClient.
Properti
base |
URL yang disediakan dalam spesifikasi layanan. Ini masih akan memiliki semua variabel templat URL di dalamnya. Jika ini tidak disediakan ketika OperationSpec dibuat, maka itu akan diisi oleh properti "baseUri" pada ServiceClient. |
content |
Jenis konten isi permintaan. Nilai ini akan digunakan sebagai header "Content-Type" jika disediakan. |
form |
Parameter ke metode operasi yang akan digunakan untuk membuat isi formdata untuk permintaan HTTP operasi. |
header |
Parameter ke metode operasi yang akan dikonversi ke header pada permintaan HTTP operasi. |
http |
Metode HTTP yang harus digunakan oleh permintaan untuk operasi ini. |
isXML | Apakah operasi ini menggunakan badan permintaan dan respons XML atau tidak. |
media |
Jenis media isi permintaan. Nilai ini dapat digunakan untuk ajudan dalam serialisasi jika disediakan. |
path | Jalur tetap untuk URL operasi ini. Ini masih akan memiliki semua variabel templat URL di dalamnya. |
query |
Parameter ke metode operasi yang akan ditambahkan ke kueri URL yang dibangun. |
request |
Parameter yang akan digunakan untuk membangun isi permintaan HTTP. |
responses | Berbagai jenis respons yang dapat dikembalikan operasi ini berdasarkan kode status apa yang dikembalikan. |
serializer | Serializer yang digunakan dalam operasi ini. |
url |
Parameter ke metode operasi yang akan diganti ke dalam URL yang dibangun. |
Detail Properti
baseUrl
URL yang disediakan dalam spesifikasi layanan. Ini masih akan memiliki semua variabel templat URL di dalamnya. Jika ini tidak disediakan ketika OperationSpec dibuat, maka itu akan diisi oleh properti "baseUri" pada ServiceClient.
baseUrl?: string
Nilai Properti
string
contentType
Jenis konten isi permintaan. Nilai ini akan digunakan sebagai header "Content-Type" jika disediakan.
contentType?: string
Nilai Properti
string
formDataParameters
Parameter ke metode operasi yang akan digunakan untuk membuat isi formdata untuk permintaan HTTP operasi.
formDataParameters?: readonly OperationParameter[]
Nilai Properti
readonly OperationParameter[]
headerParameters
Parameter ke metode operasi yang akan dikonversi ke header pada permintaan HTTP operasi.
headerParameters?: readonly OperationParameter[]
Nilai Properti
readonly OperationParameter[]
httpMethod
Metode HTTP yang harus digunakan oleh permintaan untuk operasi ini.
httpMethod: HttpMethods
Nilai Properti
isXML
Apakah operasi ini menggunakan badan permintaan dan respons XML atau tidak.
isXML?: boolean
Nilai Properti
boolean
mediaType
Jenis media isi permintaan. Nilai ini dapat digunakan untuk ajudan dalam serialisasi jika disediakan.
mediaType?: string
Nilai Properti
string
path
Jalur tetap untuk URL operasi ini. Ini masih akan memiliki semua variabel templat URL di dalamnya.
path?: string
Nilai Properti
string
queryParameters
Parameter ke metode operasi yang akan ditambahkan ke kueri URL yang dibangun.
queryParameters?: readonly OperationQueryParameter[]
Nilai Properti
readonly OperationQueryParameter[]
requestBody
Parameter yang akan digunakan untuk membangun isi permintaan HTTP.
requestBody?: OperationParameter
Nilai Properti
responses
Berbagai jenis respons yang dapat dikembalikan operasi ini berdasarkan kode status apa yang dikembalikan.
responses: {[responseCode: string]: OperationResponse}
Nilai Properti
{[responseCode: string]: OperationResponse}
serializer
urlParameters
Parameter ke metode operasi yang akan diganti ke dalam URL yang dibangun.
urlParameters?: readonly OperationURLParameter[]
Nilai Properti
readonly OperationURLParameter[]