ApiContractProperties interface
Vlastnosti entity rozhraní API
- Extends
Vlastnosti
api |
Podrobnosti o sadě verzí |
display |
Název rozhraní API. Musí mít délku 1 až 300 znaků. |
path | Relativní adresa URL jednoznačně identifikující toto rozhraní API a všechny jeho cesty k prostředkům v rámci instance služby API Management. Připojí se k základní adrese URL koncového bodu rozhraní API zadanou při vytváření instance služby a vytvoří veřejnou adresu URL pro toto rozhraní API. |
protocols | Popisuje, na kterých protokolech lze vyvolat operace v tomto rozhraní API. |
service |
Absolutní adresa URL back-endové služby implementuje toto rozhraní API. Nesmí být delší než 2 000 znaků. |
source |
Identifikátor rozhraní API zdrojového rozhraní API |
Zděděné vlastnosti
api |
Popisuje revizi rozhraní API. Pokud není zadána žádná hodnota, vytvoří se výchozí revize 1. |
api |
Popis revize rozhraní API |
api |
Typ rozhraní API. |
api |
Označuje identifikátor verze rozhraní API, pokud je rozhraní API ve verzi. |
api |
Popis verze rozhraní API |
api |
Identifikátor prostředku pro související apiVersionSet. |
authentication |
Kolekce nastavení ověřování zahrnutých v tomto rozhraní API |
contact | Kontaktní informace pro rozhraní API |
description | Popis rozhraní API Může obsahovat značky formátování HTML. |
is |
Označuje, jestli je revize rozhraní API aktuální revize rozhraní API. |
is |
Označuje, jestli je revize rozhraní API přístupná přes bránu. POZNÁMKA: Tato vlastnost nebude serializována. Může ho naplnit pouze server. |
license | Informace o licencích pro rozhraní API |
subscription |
Protokoly, přes které je k dispozici rozhraní API. |
subscription |
Určuje, jestli se pro přístup k rozhraní API vyžaduje předplatné rozhraní API nebo product. |
terms |
Adresa URL pro podmínky služby pro rozhraní API. MUSÍ být ve formátu adresy URL. |
Podrobnosti vlastnosti
apiVersionSet
Podrobnosti o sadě verzí
apiVersionSet?: ApiVersionSetContractDetails
Hodnota vlastnosti
displayName
Název rozhraní API. Musí mít délku 1 až 300 znaků.
displayName?: string
Hodnota vlastnosti
string
path
Relativní adresa URL jednoznačně identifikující toto rozhraní API a všechny jeho cesty k prostředkům v rámci instance služby API Management. Připojí se k základní adrese URL koncového bodu rozhraní API zadanou při vytváření instance služby a vytvoří veřejnou adresu URL pro toto rozhraní API.
path: string
Hodnota vlastnosti
string
protocols
Popisuje, na kterých protokolech lze vyvolat operace v tomto rozhraní API.
protocols?: string[]
Hodnota vlastnosti
string[]
serviceUrl
Absolutní adresa URL back-endové služby implementuje toto rozhraní API. Nesmí být delší než 2 000 znaků.
serviceUrl?: string
Hodnota vlastnosti
string
sourceApiId
Identifikátor rozhraní API zdrojového rozhraní API
sourceApiId?: string
Hodnota vlastnosti
string
Podrobnosti zděděných vlastností
apiRevision
Popisuje revizi rozhraní API. Pokud není zadána žádná hodnota, vytvoří se výchozí revize 1.
apiRevision?: string
Hodnota vlastnosti
string
Zděděno zApiEntityBaseContract.apiRevision
apiRevisionDescription
Popis revize rozhraní API
apiRevisionDescription?: string
Hodnota vlastnosti
string
apiType
apiVersion
Označuje identifikátor verze rozhraní API, pokud je rozhraní API ve verzi.
apiVersion?: string
Hodnota vlastnosti
string
Zděděno zapiEntityBaseContract.apiVersion
apiVersionDescription
Popis verze rozhraní API
apiVersionDescription?: string
Hodnota vlastnosti
string
apiVersionSetId
Identifikátor prostředku pro související apiVersionSet.
apiVersionSetId?: string
Hodnota vlastnosti
string
authenticationSettings
Kolekce nastavení ověřování zahrnutých v tomto rozhraní API
authenticationSettings?: AuthenticationSettingsContract
Hodnota vlastnosti
contact
Kontaktní informace pro rozhraní API
contact?: ApiContactInformation
Hodnota vlastnosti
Zděděno zapiEntityBaseContract.contact
description
Popis rozhraní API Může obsahovat značky formátování HTML.
description?: string
Hodnota vlastnosti
string
Zděděno zapiEntityBaseContract.description
isCurrent
Označuje, jestli je revize rozhraní API aktuální revize rozhraní API.
isCurrent?: boolean
Hodnota vlastnosti
boolean
Zděděno zapiEntityBaseContract.isCurrent
isOnline
Označuje, jestli je revize rozhraní API přístupná přes bránu. POZNÁMKA: Tato vlastnost nebude serializována. Může ho naplnit pouze server.
isOnline?: boolean
Hodnota vlastnosti
boolean
Zděděno zApiEntityBaseContract.isOnline
license
Informace o licencích pro rozhraní API
license?: ApiLicenseInformation
Hodnota vlastnosti
Zděděno zapiEntityBaseContract.license
subscriptionKeyParameterNames
Protokoly, přes které je k dispozici rozhraní API.
subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract
Hodnota vlastnosti
Zděděno zApiEntityBaseContract.subscriptionKeyParameterNames
subscriptionRequired
Určuje, jestli se pro přístup k rozhraní API vyžaduje předplatné rozhraní API nebo product.
subscriptionRequired?: boolean
Hodnota vlastnosti
boolean
termsOfServiceUrl
Adresa URL pro podmínky služby pro rozhraní API. MUSÍ být ve formátu adresy URL.
termsOfServiceUrl?: string
Hodnota vlastnosti
string