Bagikan melalui


ApiEntityBaseContract interface

Detail kontrak dasar API.

Properti

apiRevision

Menjelaskan revisi API. Jika tidak ada nilai yang disediakan, revisi default 1 dibuat

apiRevisionDescription

Deskripsi Revisi API.

apiType

Jenis API.

apiVersion

Menunjukkan pengidentifikasi versi API jika API diberi versi

apiVersionDescription

Deskripsi Versi API.

apiVersionSetId

Pengidentifikasi sumber daya untuk ApiVersionSet terkait.

authenticationSettings

Kumpulan pengaturan autentikasi yang disertakan dalam API ini.

contact

Informasi kontak untuk API.

description

Deskripsi API. Dapat mencakup tag pemformatan HTML.

isCurrent

Menunjukkan apakah revisi API adalah revisi api saat ini.

isOnline

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.

subscriptionKeyParameterNames

Protokol tempat API tersedia.

subscriptionRequired

Menentukan apakah API atau Langganan produk diperlukan untuk mengakses API.

termsOfServiceUrl

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

Informasi kontak untuk API.

contact?: ApiContactInformation

Nilai Properti

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

Informasi lisensi untuk API.

license?: ApiLicenseInformation

Nilai Properti

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