Udostępnij przez

Dokumentacja modelu danych szablonu usługi Azure API Management

W tym temacie opisano reprezentacje jednostek i typów dla typowych elementów używanych w modelach danych szablonów portalu dla deweloperów w usłudze Azure API Management.

Aby uzyskać więcej informacji na temat pracy z szablonami, zobacz Jak dostosować portal deweloperów usługi API Management przy użyciu szablonów.

Uwaga

Poniższa zawartość dokumentacji dotyczy przestarzałego portalu deweloperów. Można z niego korzystać na dotychczasowych zasadach aż do jego wycofania w październiku 2023 r., kiedy zostanie usunięty ze wszystkich usług API Management. Przestarzały portal będzie otrzymywać tylko krytyczne aktualizacje zabezpieczeń. Aby uzyskać więcej informacji, zapoznaj się z następującymi artykułami:

DOTYCZY: Developer | Podstawowa | Standardowa | Premium

Źródło

API (Interfejs Programowania Aplikacji)

Jednostka API ma następujące właściwości:

Nieruchomość / Majątek Typ Opis
id sznurek Identyfikator zasobu. Jednoznacznie identyfikuje API w bieżącym wystąpieniu usługi API Management. Wartość jest prawidłowym względnym adresem URL w formacie apis/{id}, gdzie {id} jest identyfikatorem API. Ta właściwość jest tylko do odczytu.
name sznurek Nazwa API. Nie może być pusty. Maksymalna długość to 100 znaków.
description sznurek Opis interfejsu API. Nie może być pusty. Może zawierać tagi formatowania HTML. Maksymalna długość to 1000 znaków.
serviceUrl sznurek Bezwzględny adres URL usługi backendowej, która realizuje ten interfejs API.
path sznurek Względny adres URL jednoznacznie identyfikujący tę usługę API i wszystkie jej ścieżki zasobów w wystąpieniu usługi API Management. Jest on dołączany do podstawowego adresu URL punktu końcowego interfejsu API określonego podczas tworzenia wystąpienia usługi w celu utworzenia publicznego adresu URL tego interfejsu API.
protocols tablica liczb Opisuje, na których protokołach w tym interfejsie API mogą być wywoływane operacje. Dozwolone wartości to 1 - http i 2 - https, lub oba.
authenticationSettings Ustawienia uwierzytelniania serwera autoryzacji Kolekcja ustawień uwierzytelniania uwzględnionych w tym interfejsie API.
subscriptionKeyParameterNames przedmiot Opcjonalna właściwość, która może służyć do określania niestandardowych nazw parametrów zapytania i/lub nagłówka zawierających klucz subskrypcji. Gdy ta właściwość jest obecna, musi zawierać co najmniej jedną z dwóch następujących właściwości.

{ "subscriptionKeyParameterNames": { "query": “customQueryParameterName", "header": “customHeaderParameterName" } }

Podsumowanie interfejsu API

Jednostka API summary ma następujące właściwości:

Nieruchomość / Majątek Typ Opis
id sznurek Identyfikator zasobu. Jednoznacznie identyfikuje API w bieżącym wystąpieniu usługi API Management. Wartość jest prawidłowym względnym adresem URL w formacie apis/{id}, gdzie {id} jest identyfikatorem API. Ta właściwość jest tylko do odczytu.
name sznurek Nazwa interfejsu API. Nie może być pusty. Maksymalna długość to 100 znaków.
description sznurek Opis interfejsu API. Nie może być pusty. Może zawierać tagi formatowania HTML. Maksymalna długość to 1000 znaków.

Aplikacja

Jednostka application ma następujące właściwości:

Nieruchomość / Majątek Typ Opis
Id sznurek Unikatowy identyfikator aplikacji.
Title sznurek Tytuł aplikacji.
Description sznurek Opis aplikacji.
Url URI URI aplikacji.
Version sznurek Informacje o wersji aplikacji.
Requirements sznurek Opis wymagań aplikacji.
State Liczba Bieżący stan aplikacji.

- 0 — Zarejestrowane

- 1 — Przesłane

- 2 — Opublikowane

- 3 — Odrzucone

- 4 — Nieopublikowane
RegistrationDate Data i Czas Data i godzina zarejestrowania aplikacji.
CategoryId Liczba Kategoria aplikacji (finanse, rozrywka itp.)
DeveloperId sznurek Unikatowy identyfikator dewelopera, który przesłał aplikację.
Attachments Kolekcja jednostek załącznik. Wszelkie załączniki dla aplikacji, takie jak zrzuty ekranu lub ikony.
Icon Załącznik Ikona aplikacji.

Załącznik

Jednostka attachment ma następujące właściwości:

Nieruchomość / Majątek Typ Opis
UniqueId sznurek Unikatowy identyfikator załącznika.
Url sznurek Adres URL zasobu.
Type sznurek Typ załącznika.
ContentType sznurek Typ nośnika załącznika.

Przykład kodu

Nieruchomość / Majątek Typ Opis
title sznurek Nazwa operacji.
snippet sznurek Ta właściwość jest przestarzała i nie powinna być używana.
brush sznurek Który szablon kolorowania składni kodu ma być używany podczas wyświetlania przykładu kodu. Dozwolone wartości to plain, php, java, xml, objc, python, ruby i csharp.
template sznurek Nazwa tego przykładowego szablonu kodu.
body sznurek Symbol zastępczy dla przykładowego fragmentu kodu.
method sznurek Metoda HTTP operacji.
scheme sznurek Protokół do użycia dla żądania operacji.
path sznurek Ścieżka operacji.
query sznurek Przykład ciągu zapytania ze zdefiniowanymi parametrami.
host sznurek Adres URL bramy usługi zarządzania API dla API zawierającej tę operację.
headers Kolekcja elementów Nagłówka. Nagłówki dla tej operacji.
parameters Kolekcja jednostek Parametr . Parametry zdefiniowane dla tej operacji.

Komentarz

Jednostka API ma następujące właściwości:

Nieruchomość / Majątek Typ Opis
Id Liczba Identyfikator komentarza.
CommentText sznurek Treść komentarza. Może zawierać kod HTML.
DeveloperCompany sznurek Nazwa firmy dewelopera.
PostedOn Data i Czas Data i godzina opublikowania komentarza.

Problematyka

Jednostka issue ma następujące właściwości.

Nieruchomość / Majątek Typ Opis
Id sznurek Unikatowy identyfikator problemu.
ApiID sznurek Identyfikator interfejsu API, dla którego zgłoszono ten problem.
Title sznurek Tytuł problemu.
Description sznurek Opis problemu.
SubscriptionDeveloperName sznurek Imię dewelopera, który zgłosił problem.
IssueState sznurek Bieżący stan problemu. Możliwe wartości to Proponowane, Otwarte, Zamknięte.
ReportedOn Data i Czas Data i godzina zgłoszenia problemu.
Comments Kolekcja elementów Komentarz. Komentarze dotyczące tego problemu.
Attachments Kolekcja jednostek załączników . Wszelkie załączniki do zgłoszenia.
Services Kolekcja jednostek interfejsu API . Interfejsy API, na które subskrybuje użytkownik, który zgłosił problem.

Filtrowanie

Jednostka filtering ma następujące właściwości:

Nieruchomość / Majątek Typ Opis
Pattern sznurek Bieżący termin wyszukiwania; lub null jeśli nie ma terminu wyszukiwania.
Placeholder sznurek Tekst do wyświetlenia w polu wyszukiwania, gdy nie określono terminu wyszukiwania.

W tej sekcji opisano reprezentację parameter .

Nieruchomość / Majątek Typ Opis
name sznurek Nazwa parametru.
description sznurek Opis parametru.
value sznurek Wartość nagłówka.
typeName sznurek Typ danych wartości nagłówka.
options sznurek Opcje.
required typ logiczny (boolowski) Czy nagłówek jest wymagany.
readOnly typ logiczny (boolowski) Czy nagłówek jest ustawiony jako tylko do odczytu?

Żądanie HTTP

W tej sekcji opisano reprezentację request .

Nieruchomość / Majątek Typ Opis
description sznurek Opis żądania operacji.
headers tablica encji Header Nagłówki żądań.
parameters tablica parametrów Kolekcja parametrów żądania operacji.
representations tablica Representation Kolekcja reprezentacji zapytań operacyjnych.

Odpowiedź HTTP

W tej sekcji opisano reprezentację response .

Nieruchomość / Majątek Typ Opis
statusCode dodatnia liczba całkowita Kod stanu reakcji operacji.
description sznurek Opis odpowiedzi operacji.
representations tablica Representation Kolekcja reprezentacji odpowiedzi na operacje.

Operacja

Jednostka operation ma następujące właściwości:

Nieruchomość / Majątek Typ Opis
id sznurek Identyfikator zasobu. Jednoznacznie identyfikuje operację w bieżącym wystąpieniu usługi API Management. Wartość jest prawidłowym względnym adresem URL w formacie, w którym apis/{aid}/operations/{id} jest identyfikatorem interfejsu {aid} API i {id} jest identyfikatorem operacji. Ta właściwość jest tylko do odczytu.
name sznurek Nazwa operacji. Nie może być pusty. Maksymalna długość to 100 znaków.
description sznurek Opis operacji. Nie może być pusty. Może zawierać tagi formatowania HTML. Maksymalna długość to 1000 znaków.
scheme sznurek Opisuje, na których protokołach w tym interfejsie API mogą być wywoływane operacje. Dozwolone wartości to http, lub httpszarówno http , jak i https.
uriTemplate sznurek Względny szablon adresu URL identyfikujący zasób docelowy dla tej operacji. Może zawierać parametry. Przykład: customers/{cid}/orders/{oid}/?date={date}
host sznurek Adres URL bramy API Management, który hostuje interfejs API.
httpMethod sznurek Metoda operacji HTTP.
request Żądanie HTTP Jednostka zawierająca szczegóły żądania.
responses tablica z odpowiedziami HTTP Tablica encji operacyjnych odpowiedzi HTTP.

Jednostka operation menu ma następujące właściwości:

Nieruchomość / Majątek Typ Opis
ApiId sznurek Identyfikator bieżącego interfejsu API.
CurrentOperationId sznurek Identyfikator aktualnej operacji.
Action sznurek Typ menu.
MenuItems Kolekcja jednostek menu operacji. Operacje dla obecnego interfejsu API.

Jednostka operation menu item ma następujące właściwości:

Nieruchomość / Majątek Typ Opis
Id sznurek Identyfikator operacji.
Title sznurek Opis operacji.
HttpMethod sznurek Metoda HTTP operacji.

Stronicowanie

Jednostka paging ma następujące właściwości:

Nieruchomość / Majątek Typ Opis
Page Liczba Bieżący numer strony.
PageSize Liczba Maksymalna liczba wyników, które mają być wyświetlane na jednej stronie.
TotalItemCount Liczba Liczba elementów do wyświetlenia.
ShowAll typ logiczny (boolowski) Czy mają być wyświetlane wszystkie wyniki na jednej stronie.
PageCount Liczba Liczba stron wyników.

Parametr

W tej sekcji opisano reprezentację parameter .

Nieruchomość / Majątek Typ Opis
name sznurek Nazwa parametru.
description sznurek Opis parametru.
value sznurek Wartość parametru.
options tablica ciągów znaków Wartości zdefiniowane dla wartości parametrów zapytania.
required typ logiczny (boolowski) Określa, czy parametr jest wymagany, czy nie.
kind Liczba Czy ten parametr jest parametrem ścieżki (1), czy parametrem querystring (2).
typeName sznurek Typ parametru.

Produkt

Jednostka product ma następujące właściwości:

Nieruchomość / Majątek Typ Opis
Id sznurek Identyfikator zasobu. Unikalnie identyfikuje produkt w bieżącym wystąpieniu usługi API Management. Wartość jest prawidłowym względnym adresem URL w formacie products/{pid} , w którym {pid} jest identyfikatorem produktu. Ta właściwość jest tylko do odczytu.
Title sznurek Nazwa produktu. Nie może być pusty. Maksymalna długość to 100 znaków.
Description sznurek Opis produktu. Nie może być pusty. Może zawierać tagi formatowania HTML. Maksymalna długość to 1000 znaków.
Terms sznurek Warunki użytkowania produktu. Deweloperzy próbujący zasubskrybować produkt będą przedstawiani i zobowiązani do zaakceptowania tych warunków przed ukończeniem procesu subskrypcji.
ProductState Liczba Określa, czy produkt jest publikowany, czy nie. Opublikowane produkty są wykrywalne przez deweloperów w portalu deweloperów. Niepublikowane produkty są widoczne tylko dla administratorów.

Dozwolone wartości stanu produktu to:

- 0 - Not Published

- 1 - Published

- 2 - Deleted
AllowMultipleSubscriptions typ logiczny (boolowski) Określa, czy użytkownik może mieć wiele subskrypcji do tego produktu w tym samym czasie.
MultipleSubscriptionsCount Liczba Maksymalna liczba subskrypcji tego produktu, które użytkownik może mieć w tym samym czasie.

Dostawca

Jednostka provider ma następujące właściwości:

Nieruchomość / Majątek Typ Opis
Properties słownik łańcuchów znaków Właściwości tego dostawcy uwierzytelniania.
AuthenticationType sznurek Typ dostawcy. (Microsoft Entra ID, logowanie Facebook, Konto Google, Konto Microsoft, Twitter).
Caption sznurek Nazwa wyświetlana dostawcy.

Reprezentacja

W tej sekcji opisano element representation.

Nieruchomość / Majątek Typ Opis
contentType sznurek Określa zarejestrowany lub niestandardowy typ zawartości dla tej reprezentacji, na przykład application/xml.
sample sznurek Przykład reprezentacji.

Subskrypcja

Jednostka subscription ma następujące właściwości:

Nieruchomość / Majątek Typ Opis
Id sznurek Identyfikator zasobu. Jednoznacznie identyfikuje subskrypcję w bieżącym wystąpieniu usługi API Management. Wartość jest prawidłowym względnym adresem URL w formacie subscriptions/{sid} , w którym {sid} jest identyfikatorem subskrypcji. Ta właściwość jest tylko do odczytu.
ProductId sznurek Identyfikator zasobu subskrybowanego produktu. Wartość jest prawidłowym względnym adresem URL w formacie products/{pid} , w którym {pid} jest identyfikatorem produktu.
ProductTitle sznurek Nazwa produktu. Nie może być pusty. Maksymalna długość to 100 znaków.
ProductDescription sznurek Opis produktu. Nie może być pusty. Może zawierać tagi formatowania HTML. Maksymalna długość to 1000 znaków.
ProductDetailsUrl sznurek Względny adres URL do informacji o produkcie.
state sznurek Stan subskrypcji. Możliwe stany to:

- 0 - suspended — subskrypcja jest zablokowana, a subskrybent nie może wywołać żadnych interfejsów API produktu.

- 1 - active — subskrypcja jest aktywna.

- 2 - expired — subskrypcja osiągnęła datę wygaśnięcia i została zdezaktywowana.

- 3 - submitted — żądanie subskrypcji zostało złożone przez dewelopera, ale nie zostało jeszcze zatwierdzone ani odrzucone.

- 4 - rejected — żądanie subskrypcji zostało odrzucone przez administratora.

- 5 - cancelled — subskrypcja została anulowana przez dewelopera lub administratora.
DisplayName sznurek Nazwa wyświetlana subskrypcji.
CreatedDate data i czas Data utworzenia subskrypcji w formacie ISO 8601: 2014-06-24T16:25:00Z.
CanBeCancelled typ logiczny (boolowski) Czy subskrypcja może zostać anulowana przez bieżącego użytkownika.
IsAwaitingApproval typ logiczny (boolowski) Czy subskrypcja oczekuje na zatwierdzenie.
StartDate data i czas Data rozpoczęcia subskrypcji w formacie ISO 8601: 2014-06-24T16:25:00Z.
ExpirationDate data i czas Data wygaśnięcia subskrypcji w formacie ISO 8601: 2014-06-24T16:25:00Z.
NotificationDate data i czas Data wysłania powiadomienia o subskrypcji w formacie ISO 8601: 2014-06-24T16:25:00Z.
primaryKey sznurek Podstawowy klucz subskrypcji. Maksymalna długość to 256 znaków.
secondaryKey sznurek Pomocniczy klucz subskrypcji. Maksymalna długość to 256 znaków.
CanBeRenewed typ logiczny (boolowski) Czy subskrypcja może zostać odnowiona przez bieżącego użytkownika.
HasExpired typ logiczny (boolowski) Czy subskrypcja wygasła.
IsRejected typ logiczny (boolowski) Czy żądanie subskrypcji zostało odrzucone.
CancelUrl sznurek Relatywny adres URL do anulowania subskrypcji.
RenewUrl sznurek Względny adres URL do odnowienia subskrypcji.

Podsumowanie subskrypcji

Jednostka subscription summary ma następujące właściwości:

Nieruchomość / Majątek Typ Opis
Id sznurek Identyfikator zasobu. Jednoznacznie identyfikuje subskrypcję w bieżącym wystąpieniu usługi API Management. Wartość jest prawidłowym względnym adresem URL w formacie subscriptions/{sid} , w którym {sid} jest identyfikatorem subskrypcji. Ta właściwość jest tylko do odczytu.
DisplayName sznurek Nazwa wyświetlana subskrypcji

Informacje o koncie użytkownika

Jednostka user account info ma następujące właściwości:

Nieruchomość / Majątek Typ Opis
FirstName sznurek Imię. Nie może być pusty. Maksymalna długość to 100 znaków.
LastName sznurek Nazwisko. Nie może być pusty. Maksymalna długość to 100 znaków.
Email sznurek Adres e-mail. Nie może być puste i musi być unikalne w ramach wystąpienia usługi. Maksymalna długość to 254 znaki.
Password sznurek Hasło konta użytkownika.
NameIdentifier sznurek Identyfikator konta, taki sam jak adres e-mail użytkownika.
ProviderName sznurek Nazwa dostawcy uwierzytelniania.
IsBasicAccount typ logiczny (boolowski) Prawda, jeśli to konto zostało zarejestrowane przy użyciu poczty e-mail i hasła; false, jeśli konto zostało zarejestrowane przy użyciu dostawcy.

Logowanie użytkowników

Jednostka user sign in ma następujące właściwości:

Nieruchomość / Majątek Typ Opis
Email sznurek Adres e-mail. Nie może być puste i musi być unikalne w ramach wystąpienia usługi. Maksymalna długość to 254 znaki.
Password sznurek Hasło konta użytkownika.
ReturnUrl sznurek Adres URL strony, w której użytkownik kliknął pozycję Zaloguj się.
RememberMe typ logiczny (boolowski) Czy zapisać informacje bieżącego użytkownika.
RegistrationEnabled typ logiczny (boolowski) Czy rejestracja jest włączona.
DelegationEnabled typ logiczny (boolowski) Czy logowanie delegowane jest włączone.
DelegationUrl sznurek Adres URL logowania delegowanego, jeśli jest włączony.
SsoSignUpUrl sznurek Adres URL logowania jednokrotnego dla użytkownika, jeśli istnieje.
AuxServiceUrl sznurek Jeśli bieżący użytkownik jest administratorem, jest to link do wystąpienia usługi w portalu Azure.
Providers Kolekcja jednostek dostawcy Dostawcy uwierzytelniania dla tego użytkownika.
UserRegistrationTerms sznurek Warunki, na które użytkownik musi wyrazić zgodę przed zalogowaniem się.
UserRegistrationTermsEnabled typ logiczny (boolowski) Określa, czy terminy są włączone.

Rejestracja użytkownika

Jednostka user sign up ma następujące właściwości:

Nieruchomość / Majątek Typ Opis
PasswordConfirm typ logiczny (boolowski) Wartość używana przez kontrolkę rejestracji.
Password sznurek Hasło konta użytkownika.
PasswordVerdictLevel Liczba Wartość używana przez kontrolkę rejestracji.
UserRegistrationTerms sznurek Warunki, na które użytkownik musi wyrazić zgodę przed zalogowaniem się.
UserRegistrationTermsOptions Liczba Wartość używana przez kontrolkę rejestracji.
ConsentAccepted typ logiczny (boolowski) Wartość używana przez kontrolkę rejestracji.
Email sznurek Adres e-mail. Nie może być puste i musi być unikalne w ramach wystąpienia usługi. Maksymalna długość to 254 znaki.
FirstName sznurek Imię. Nie może być pusty. Maksymalna długość to 100 znaków.
LastName sznurek Nazwisko. Nie może być pusty. Maksymalna długość to 100 znaków.
UserData sznurek Wartość używana przez kontrolkę rejestracji .
NameIdentifier sznurek Wartość używana przez kontrolkę rejestracji.
ProviderName sznurek Nazwa dostawcy uwierzytelniania.

Następne kroki

Aby uzyskać więcej informacji na temat pracy z szablonami, zobacz Jak dostosować portal deweloperów usługi API Management przy użyciu szablonów.

  • Last updated on