Udostępnij za pośrednictwem

Dokumentacja modelu danych szablonu usługi Azure API Management

  • Artykuł

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

Aby uzyskać więcej informacji na temat pracy z szablonami, zobacz Jak dostosować portal deweloperów 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 szczegółowych informacji, zapoznaj się z następującymi artykułami:

Dostępność

Ważne

Ta funkcja jest dostępna w warstwach Premium, Standardowa, Podstawowa i Deweloper usługi API Management.

Aby uzyskać informacje o dostępności funkcji w warstwach 2 (wersja zapoznawcza), zobacz Omówienie warstw w wersji 2.

Odwołanie

interfejs API

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

Właściwość Typ Opis
id ciąg Identyfikator zasobu. Unikatowo identyfikuje interfejs API w bieżącym wystąpieniu usługi API Management. Wartość jest prawidłowym względnym adresem URL w formacie, w którym {id} jest identyfikatorem interfejsu apis/{id} API. Ta właściwość jest tylko do odczytu.
name ciąg Nazwa interfejsu API. Nie może być pusty. Maksymalna długość to 100 znaków.
description ciąg Opis interfejsu API. Nie może być pusty. Może zawierać tagi formatowania HTML. Maksymalna długość to 1000 znaków.
serviceUrl ciąg Bezwzględny adres URL usługi zaplecza implementowania tego interfejsu API.
path ciąg Względny adres URL jednoznacznie identyfikujący ten interfejs API i wszystkie jego ścieżki zasobów w ramach wystąpienia 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 dla tego interfejsu API.
protocols tablica liczb Opisuje, na których protokołach można wywołać operacje w tym interfejsie API. 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 object 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:

Właściwość Typ Opis
id ciąg Identyfikator zasobu. Unikatowo identyfikuje interfejs API w bieżącym wystąpieniu usługi API Management. Wartość jest prawidłowym względnym adresem URL w formacie, w którym {id} jest identyfikatorem interfejsu apis/{id} API. Ta właściwość jest tylko do odczytu.
name ciąg Nazwa interfejsu API. Nie może być pusty. Maksymalna długość to 100 znaków.
description ciąg 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:

Właściwość Typ Opis
Id ciąg Unikatowy identyfikator aplikacji.
Title ciąg Tytuł aplikacji.
Description ciąg Opis aplikacji.
Url URI Identyfikator URI aplikacji.
Version ciąg Informacje o wersji aplikacji.
Requirements ciąg Opis wymagań aplikacji.
State liczba Bieżący stan aplikacji.

- 0 — Zarejestrowane

- 1 — Przesłane

- 2 — Opublikowane

- 3 — Odrzucone

- 4 — Cofnięto publikowanie
RegistrationDate DateTime Data i godzina zarejestrowania aplikacji.
CategoryId liczba Kategoria aplikacji (Finanse, rozrywka itp.)
DeveloperId ciąg Unikatowy identyfikator dewelopera, który przesłał aplikację.
Attachments Kolekcja jednostek załączników . Wszystkie załączniki aplikacji, takie jak zrzuty ekranu lub ikony.
Icon Załącznik Ikona aplikacji.

Załącznik

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

Właściwość Typ Opis
UniqueId ciąg Unikatowy identyfikator załącznika.
Url ciąg Adres URL zasobu.
Type ciąg Typ załącznika.
ContentType ciąg Typ nośnika załącznika.

Przykład kodu

Właściwość Typ Opis
title ciąg Nazwa operacji.
snippet ciąg Ta właściwość jest przestarzała i nie powinna być używana.
brush ciąg Który szablon kolorowania składni kodu, który ma być używany podczas wyświetlania przykładu kodu. Dozwolone wartości to plain, , javaobjcxmlpythonphp, ruby, i .csharp
template ciąg Nazwa tego przykładowego szablonu kodu.
body ciąg Symbol zastępczy przykładowej części kodu fragmentu kodu.
method ciąg Metoda HTTP operacji.
scheme ciąg Protokół do użycia dla żądania operacji.
path ciąg Ścieżka operacji.
query ciąg Przykład ciągu zapytania ze zdefiniowanymi parametrami.
host ciąg Adres URL bramy usługi API Management dla interfejsu API zawierającego tę operację.
headers Kolekcja jednostek nagłówka . Nagłówki dla tej operacji.
parameters Kolekcja jednostek parametrów . Parametry zdefiniowane dla tej operacji.

Komentarz

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

Właściwość Typ Opis
Id liczba Identyfikator komentarza.
CommentText ciąg Treść komentarza. Może zawierać kod HTML.
DeveloperCompany ciąg Nazwa firmy dewelopera.
PostedOn DateTime Data i godzina opublikowania komentarza.

Problem

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

Właściwość Typ Opis
Id ciąg Unikatowy identyfikator problemu.
ApiID ciąg Identyfikator interfejsu API, dla którego zgłoszono ten problem.
Title ciąg Tytuł problemu.
Description ciąg Opis problemu.
SubscriptionDeveloperName ciąg Imię dewelopera, który zgłosił problem.
IssueState ciąg Bieżący stan problemu. Możliwe wartości to Proponowane, Otwarte, Zamknięte.
ReportedOn DateTime Data i godzina zgłoszenia problemu.
Comments Kolekcja jednostek komentarza . Komentarze dotyczące tego problemu.
Attachments Kolekcja jednostek załączników . Wszelkie załączniki do problemu.
Services Kolekcja jednostek interfejsu API . Interfejsy API subskrybowane przez użytkownika, który złożył problem.

Filtrowanie

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

Właściwość Typ Opis
Pattern ciąg Bieżący termin wyszukiwania; lub null jeśli nie ma terminu wyszukiwania.
Placeholder ciąg Tekst do wyświetlenia w polu wyszukiwania, gdy nie określono terminu wyszukiwania.

W tej sekcji opisano reprezentację parameter .

Właściwość Typ Opis
name ciąg Nazwa parametru.
description ciąg Opis parametru.
value ciąg Wartość nagłówka.
typeName ciąg Typ danych wartości nagłówka.
options ciąg Opcje.
required boolean Określa, czy nagłówek jest wymagany.
readOnly boolean Określa, czy nagłówek jest tylko do odczytu.

Żądanie HTTP

W tej sekcji opisano reprezentację request .

Właściwość Typ Opis
description ciąg Opis żądania operacji.
headers tablica jednostek nagłówka . Nagłówki żądań.
parameters tablica parametru Kolekcja parametrów żądania operacji.
representations tablica reprezentacji Kolekcja reprezentacji żądań operacji.

Odpowiedź HTTP

W tej sekcji opisano reprezentację response .

Właściwość Typ Opis
statusCode dodatnia liczba całkowita Kod stanu odpowiedzi operacji.
description ciąg Opis odpowiedzi operacji.
representations tablica reprezentacji Kolekcja reprezentacji odpowiedzi operacji.

Operacja

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

Właściwość Typ Opis
id ciąg Identyfikator zasobu. Unikatowo identyfikuje operację w bieżącym wystąpieniu usługi API Management. Wartość jest prawidłowym względnym adresem URL w formacie, w którym {aid} jest identyfikatorem interfejsu apis/{aid}/operations/{id} API i {id} jest identyfikatorem operacji. Ta właściwość jest tylko do odczytu.
name ciąg Nazwa operacji. Nie może być pusty. Maksymalna długość to 100 znaków.
description ciąg Opis operacji. Nie może być pusty. Może zawierać tagi formatowania HTML. Maksymalna długość to 1000 znaków.
scheme ciąg Opisuje, na których protokołach można wywołać operacje w tym interfejsie API. Dozwolone wartości to http, httpslub , http i https.
uriTemplate ciąg 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 ciąg Adres URL bramy API Management hostujący interfejs API.
httpMethod ciąg Metoda HTTP operacji.
request Żądanie HTTP Jednostka zawierająca szczegóły żądania.
responses tablica odpowiedzi HTTP Tablica jednostek odpowiedzi HTTP operacji .

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

Właściwość Typ Opis
ApiId ciąg Identyfikator bieżącego interfejsu API.
CurrentOperationId ciąg Identyfikator bieżącej operacji.
Action ciąg Typ menu.
MenuItems Kolekcja jednostek elementów menu Operacja . Operacje dla bieżącego interfejsu API.

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

Właściwość Typ Opis
Id ciąg Identyfikator operacji.
Title ciąg Opis operacji.
HttpMethod ciąg Metoda Http operacji.

Stronicowanie

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

Właściwość 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 boolean Czy poszybować wszystkie wyniki na jednej stronie.
PageCount liczba Liczba stron wyników.

Parametr

W tej sekcji opisano reprezentację parameter .

Właściwość Typ Opis
name ciąg Nazwa parametru.
description ciąg Opis parametru.
value ciąg Wartość parametru.
options tablica ciągów Wartości zdefiniowane dla wartości parametrów zapytania.
required boolean Określa, czy parametr jest wymagany, czy nie.
kind liczba Niezależnie od tego, czy ten parametr jest parametrem ścieżki (1), czy parametrem zapytań (2).
typeName ciąg Typ parametru.

Produkt

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

Właściwość Typ Opis
Id ciąg Identyfikator zasobu. Unikatowo 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 ciąg Nazwa produktu. Nie może być pusty. Maksymalna długość to 100 znaków.
Description ciąg Opis produktu. Nie może być pusty. Może zawierać tagi formatowania HTML. Maksymalna długość to 1000 znaków.
Terms ciąg Warunki użytkowania produktu. Deweloperzy próbujący zasubskrybować produkt będą prezentowani i zobowiązani do zaakceptowania tych warunków, zanim będą mogli ukończyć proces subskrypcji.
ProductState liczba Określa, czy produkt jest publikowany, czy nie. Opublikowane produkty są wykrywalne przez deweloperów w portalu deweloperów. Nieopublikowane produkty są widoczne tylko dla administratorów.

Dozwolone wartości stanu produktu to:

- 0 - Not Published

- 1 - Published

- 2 - Deleted
AllowMultipleSubscriptions boolean 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:

Właściwość Typ Opis
Properties słownik ciągów Właściwości tego dostawcy uwierzytelniania.
AuthenticationType ciąg Typ dostawcy. (identyfikator Microsoft Entra, logowanie do Serwisu Facebook, konto Google, konto Microsoft, Twitter).
Caption ciąg Nazwa wyświetlana dostawcy.

Reprezentacja

W tej sekcji opisano element representation.

Właściwość Typ Opis
contentType ciąg Określa zarejestrowany lub niestandardowy typ zawartości dla tej reprezentacji, na przykład application/xml.
sample ciąg Przykład reprezentacji.

Subskrypcja

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

Właściwość Typ Opis
Id ciąg Identyfikator zasobu. Unikatowo 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 ciąg Identyfikator zasobu produktu subskrybowanego produktu. Wartość jest prawidłowym względnym adresem URL w formacie products/{pid} , w którym {pid} jest identyfikatorem produktu.
ProductTitle ciąg Nazwa produktu. Nie może być pusty. Maksymalna długość to 100 znaków.
ProductDescription ciąg Opis produktu. Nie może być pusty. Może zawierać tagi formatowania HTML. Maksymalna długość to 1000 znaków.
ProductDetailsUrl ciąg Względny adres URL do szczegółów produktu.
state ciąg 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 – wniosek o subskrypcję został złożony przez dewelopera, ale nie został jeszcze zatwierdzony lub odrzucony.

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

- 5 - cancelled – subskrypcja została anulowana przez dewelopera lub administratora.
DisplayName ciąg Nazwa wyświetlana subskrypcji.
CreatedDate Data i godzina Data utworzenia subskrypcji w formacie ISO 8601: 2014-06-24T16:25:00Z.
CanBeCancelled boolean Czy subskrypcja może zostać anulowana przez bieżącego użytkownika.
IsAwaitingApproval boolean Czy subskrypcja oczekuje na zatwierdzenie.
StartDate Data i godzina Data rozpoczęcia subskrypcji w formacie ISO 8601: 2014-06-24T16:25:00Z.
ExpirationDate Data i godzina Data wygaśnięcia subskrypcji w formacie ISO 8601: 2014-06-24T16:25:00Z.
NotificationDate Data i godzina Data powiadomienia dla subskrypcji w formacie ISO 8601: 2014-06-24T16:25:00Z.
primaryKey ciąg Podstawowy klucz subskrypcji. Maksymalna długość to 256 znaków.
secondaryKey ciąg Pomocniczy klucz subskrypcji. Maksymalna długość to 256 znaków.
CanBeRenewed boolean Czy subskrypcja może zostać odnowiona przez bieżącego użytkownika.
HasExpired boolean Czy subskrypcja wygasła.
IsRejected boolean Czy żądanie subskrypcji zostało odrzucone.
CancelUrl ciąg Względny adres URL umożliwiający anulowanie subskrypcji.
RenewUrl ciąg Względny adres URL do odnowienia subskrypcji.

Podsumowanie subskrypcji

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

Właściwość Typ Opis
Id ciąg Identyfikator zasobu. Unikatowo 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 ciąg Nazwa wyświetlana subskrypcji

Informacje o koncie użytkownika

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

Właściwość Typ Opis
FirstName ciąg Imię. Nie może być pusty. Maksymalna długość to 100 znaków.
LastName ciąg Nazwisko. Nie może być pusty. Maksymalna długość to 100 znaków.
Email ciąg Adres e-mail. Nie może być pusty i musi być unikatowy w ramach wystąpienia usługi. Maksymalna długość to 254 znaki.
Password ciąg Hasło konta użytkownika.
NameIdentifier ciąg Identyfikator konta, taki sam jak adres e-mail użytkownika.
ProviderName ciąg Nazwa dostawcy uwierzytelniania.
IsBasicAccount boolean 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żytkownika

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

Właściwość Typ Opis
Email ciąg Adres e-mail. Nie może być pusty i musi być unikatowy w ramach wystąpienia usługi. Maksymalna długość to 254 znaki.
Password ciąg Hasło konta użytkownika.
ReturnUrl ciąg Adres URL strony, w której użytkownik kliknął logowanie.
RememberMe boolean Czy zapisać informacje bieżącego użytkownika.
RegistrationEnabled boolean Czy rejestracja jest włączona.
DelegationEnabled boolean Czy logowanie delegowane jest włączone.
DelegationUrl ciąg Adres URL logowania delegowanego, jeśli jest włączony.
SsoSignUpUrl ciąg Adres URL logowania jednokrotnego dla użytkownika, jeśli jest obecny.
AuxServiceUrl ciąg Jeśli bieżący użytkownik jest administratorem, jest to link do wystąpienia usługi w Azure Portal.
Providers Kolekcja jednostek dostawcy Dostawcy uwierzytelniania dla tego użytkownika.
UserRegistrationTerms ciąg Warunki, na które użytkownik musi wyrazić zgodę przed zalogowaniem się.
UserRegistrationTermsEnabled boolean Określa, czy terminy są włączone.

Rejestracja użytkownika

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

Właściwość Typ Opis
PasswordConfirm boolean Wartość używana przez kontrolkę rejestracji.
Password ciąg Hasło konta użytkownika.
PasswordVerdictLevel liczba Wartość używana przez kontrolkę rejestracji.
UserRegistrationTerms ciąg Warunki, na które użytkownik musi wyrazić zgodę przed zalogowaniem się.
UserRegistrationTermsOptions liczba Wartość używana przez kontrolkę rejestracji.
ConsentAccepted boolean Wartość używana przez kontrolkę rejestracji.
Email ciąg Adres e-mail. Nie może być pusty i musi być unikatowy w ramach wystąpienia usługi. Maksymalna długość to 254 znaki.
FirstName ciąg Imię. Nie może być pusty. Maksymalna długość to 100 znaków.
LastName ciąg Nazwisko. Nie może być pusty. Maksymalna długość to 100 znaków.
UserData ciąg Wartość używana przez kontrolkę rejestracji .
NameIdentifier ciąg Wartość używana przez kontrolkę rejestracji.
ProviderName ciąg Nazwa dostawcy uwierzytelniania.

Następne kroki

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