ApiEntityBaseContract interface
Detail kontrak dasar API.
Properti
| api |
Menjelaskan revisi API. Jika tidak ada nilai yang disediakan, revisi default 1 dibuat |
| api |
Deskripsi Revisi API. |
| api |
Jenis API. |
| api |
Menunjukkan pengidentifikasi versi API jika API diberi versi |
| api |
Deskripsi Versi API. |
| api |
Pengidentifikasi sumber daya untuk ApiVersionSet terkait. |
| authentication |
Kumpulan pengaturan autentikasi yang disertakan dalam API ini. |
| contact | Informasi kontak untuk API. |
| description | Deskripsi API. Dapat mencakup tag pemformatan HTML. |
| is |
Menunjukkan apakah revisi API adalah revisi api saat ini. |
| is |
Menunjukkan apakah revisi API dapat diakses melalui gateway. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server. |
| license | Informasi lisensi untuk API. |
| subscription |
Protokol tempat API tersedia. |
| subscription |
Menentukan apakah API atau Langganan produk diperlukan untuk mengakses API. |
| terms |
URL ke Ketentuan Layanan untuk API. HARUS dalam format URL. |
Detail Properti
apiRevision
Menjelaskan revisi API. Jika tidak ada nilai yang disediakan, revisi default 1 dibuat
apiRevision?: string
Nilai Properti
string
apiRevisionDescription
Deskripsi Revisi API.
apiRevisionDescription?: string
Nilai Properti
string
apiType
Jenis API.
apiType?: string
Nilai Properti
string
apiVersion
Menunjukkan pengidentifikasi versi API jika API diberi versi
apiVersion?: string
Nilai Properti
string
apiVersionDescription
Deskripsi Versi API.
apiVersionDescription?: string
Nilai Properti
string
apiVersionSetId
Pengidentifikasi sumber daya untuk ApiVersionSet terkait.
apiVersionSetId?: string
Nilai Properti
string
authenticationSettings
Kumpulan pengaturan autentikasi yang disertakan dalam API ini.
authenticationSettings?: AuthenticationSettingsContract
Nilai Properti
contact
description
Deskripsi API. Dapat mencakup tag pemformatan HTML.
description?: string
Nilai Properti
string
isCurrent
Menunjukkan apakah revisi API adalah revisi api saat ini.
isCurrent?: boolean
Nilai Properti
boolean
isOnline
Menunjukkan apakah revisi API dapat diakses melalui gateway. CATATAN: Properti ini tidak akan diserialisasikan. Ini hanya dapat diisi oleh server.
isOnline?: boolean
Nilai Properti
boolean
license
subscriptionKeyParameterNames
Protokol tempat API tersedia.
subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract
Nilai Properti
subscriptionRequired
Menentukan apakah API atau Langganan produk diperlukan untuk mengakses API.
subscriptionRequired?: boolean
Nilai Properti
boolean
termsOfServiceUrl
URL ke Ketentuan Layanan untuk API. HARUS dalam format URL.
termsOfServiceUrl?: string
Nilai Properti
string