Dokumentacja interfejsu wiersza polecenia narzędzia Data API Builder
Interfejs wiersza polecenia (CLI) konstruktora interfejsu api danych (CLI) (interfejs wiersza polecenia dab lub dab) to narzędzie wiersza polecenia, które usprawnia lokalne środowisko programistyczne dla aplikacji przy użyciu konstruktora interfejsu API danych.
Napiwek
Interfejs wiersza polecenia konstruktora interfejsu API danych jest dostarczany ze zintegrowanym systemem pomocy. Aby uzyskać listę dostępnych poleceń, użyj opcji --help w poleceniu dab.
dab --help
Aby uzyskać pomoc dotyczącą określonego polecenia, użyj opcji --help. Aby na przykład dowiedzieć się więcej na temat polecenia init:
dab init --help
Czasowniki i opcje wiersza polecenia
init
Inicjuje konfigurację środowiska uruchomieniowego aparatu środowiska uruchomieniowego konstruktora interfejsu API danych. Tworzy nowy plik JSON z właściwościami podanymi jako opcje.
Składnia
dab init [options]
Przykłady
dab init --config "dab-config.mssql.json" --database-type mssql --connection-string "@env('SQL_CONNECTION_STRING')"
dab init --database-type mysql --connection-string "@env('MYSQL_CONNECTION_STRING')" --graphql.multiple-create.enabled true
Opcje
| Opcje | Wymagana opcja | Wartość domyślna | Wymagana wartość | Typ wartości | Opis |
|---|---|---|---|---|---|
| --database-type | ✔️ Tak | ✔️ Tak | struna | Typ bazy danych do nawiązania połączenia. Obsługiwane wartości: mssql, cosmosdb_nosql, cosmosdb_postgresql, mysql, postgresql. |
|
| --connection-string | ❌ nie | "" |
✔️ Tak | struna | Szczegóły połączenia w celu nawiązania połączenia z bazą danych. |
| --cosmosdb_nosql-database | ✔️ Tak ¹ | ✔️ Tak | struna | Nazwa bazy danych dla usługi Cosmos DB dla NoSql. | |
| --cosmosdb_nosql-container | ❌ nie | ✔️ Tak | struna | Nazwa kontenera dla usługi Cosmos DB dla NoSql. | |
| --graphql-schema | ✔️ Tak ¹ | ✔️ Tak | struna | Ścieżka schematu GraphQL | |
| --set-session-context | ❌ nie | false |
❌ nie | Włącz wysyłanie danych do usługi MsSql przy użyciu kontekstu sesji. | |
| --host-mode | ❌ nie | production |
✔️ Tak | struna | Określanie trybu hosta — programowanie lub produkcja |
| --cors-origin | ❌ nie | "" |
✔️ Tak | struna | Określ listę dozwolonych źródeł. |
| --auth.provider | ❌ nie | StaticWebApps |
✔️ Tak | struna | Określ dostawcę tożsamości. |
| --rest.path | ❌ nie | /api |
✔️ Tak | struna | Określ prefiks punktu końcowego REST. |
| --rest.enabled | ❌ nie | true |
✔️ Tak | boolowski | Włącza punkt końcowy REST dla wszystkich jednostek. |
| --rest.request-body-strict | ❌ nie | true |
✔️ Tak | Nie zezwala na nadmiarowe pola w treści żądania. | |
| --graphql.path | ❌ nie | /graphql |
✔️ Tak | struna | Określ prefiks punktu końcowego GraphQL. |
| --graphql.enabled | ❌ nie | true |
✔️ Tak | boolowski | Włącza punkt końcowy graphQL dla wszystkich jednostek. |
| --graphql.multiple-create.enabled | ❌ nie | false |
✔️ Tak | Włącza wiele funkcji tworzenia w narzędziu GraphQL. | |
| --auth.audience | ❌ nie | ✔️ Tak | struna | Identyfikuje adresatów, dla których jest przeznaczony token internetowy Json (JWT). | |
| --auth.issuer | ❌ nie | ✔️ Tak | struna | Określ jednostkę, która wystawiła token JWT. | |
| -c,--config | ❌ nie | dab-config.json |
✔️ Tak | struna | Ścieżka do pliku konfiguracji. |
¹ Ta opcja jest wymagana tylko wtedy, gdy --database-type jest ustawiona na wartość cosmosdb_nosql.
add
Dodaj nową jednostkę bazy danych do pliku konfiguracji. Przed wykonaniem tego polecenia upewnij się, że masz już plik konfiguracji. W przeciwnym razie zwraca błąd.
Składnia
dab add [entity-name] [options]
Przykłady
dab add Book -c "dab-config.MsSql.json" --source dbo.books --permissions "anonymous:*"
Opcje
| Opcje | Wymagana opcja | Wartość domyślna | Wymagana wartość | Typ wartości | Opis |
|---|---|---|---|---|---|
| -s,--source | ✔️ Tak | ✔️ Tak | struna | Nazwa tabeli źródłowej lub kontenera. | |
| --permissions | ✔️ Tak | ✔️ Tak | struna | Uprawnienia wymagane do uzyskania dostępu do tabeli źródłowej lub kontenera. Format: [role]:[actions]. |
|
| --source.type | ❌ nie | table |
✔️ Tak | struna | Typ obiektu bazy danych. Obsługiwane wartości: table, view, stored-procedure. |
| --source.params | ❌ nie | ✔️ Tak | struna | Słownik parametrów procedury składowanej i ich typów danych. Obsługiwane typy danych to string, numberi boolean. Parametry są określone w formacie: paramName:type. Na przykład: --source.params "id:number,isActive:boolean,name:string". |
|
| pól |
✔️ Tak ¹ | ✔️ Tak | struna | Co najmniej jedno pole, które ma być używane jako klucze podstawowe tylko dla tabel i widoków. Wartości rozdzielone przecinkami. Przykład --source.key-fields "id,name,type". |
|
| --rest | ❌ nie | nazwa jednostki uwzględniająca wielkość liter | ✔️ Tak | struna | Trasa dla interfejsu API REST. Przykłady: --rest: false —> wyłącza wywołania interfejsu API REST dla tej jednostki.
--rest: true —> nazwa jednostki staje się ścieżką rest.
--rest: "customPathName" —> Provided customPathName staje się ścieżką REST. |
| --rest.methods | ❌ nie | post |
✔️ Tak | struna | Akcje HTTP, które mają być obsługiwane w przypadku procedury składowanej. Określ akcje jako listę rozdzielaną przecinkami. Prawidłowe akcje HTTP to:[get, post, put, patch, delete]. |
| --graphql | ❌ nie | nazwa jednostki uwzględniająca wielkość liter | ✔️ Tak | Wartość logiczna/ciąg | Uwidoczniony typ jednostki dla języka GraphQL. Przykłady: --graphql: false —> wyłącza wywołania graphql dla tej jednostki.
--graphql: true —> uwidacznia jednostkę dla języka GraphQL z nazwami domyślnymi. Pojedyncza forma nazwy jednostki jest uważana za nazwę zapytania i mutacji.
--graphql: "customQueryName" —> Jawnie ustawia wartość pojedynczą, podczas gdy daB pluralizuje podaną wartość zapytań i mutacji.
--graphql: "singularName:pluralName" —> ustawia zarówno wartości pojedyncze, jak i mnogie (rozdzielane dwukropkiem :) używane do zapytań i mutacji. |
| --graphql.operation | ❌ nie | mutation |
✔️ Tak | struna | Operacja GraphQL, która ma być obsługiwana w przypadku procedury składowanej. Obsługiwane wartości: query, mutation. |
| --fields.include | ❌ nie | ✔️ Tak | struna | Pola z uprawnieniami dostępu. | |
| --fields.exclude | ❌ nie | ✔️ Tak | struna | Pola wykluczone z list akcji. | |
| --policy-database | ❌ nie | ✔️ Tak | struna | Określ regułę filtru stylu OData, która jest wstrzykiwana w zapytaniu wysyłanym do bazy danych. | |
| -c,--config | ❌ nie | dab-config.json |
✔️ Tak | struna | Ścieżka do pliku konfiguracji. |
¹ Ta opcja jest wymagana tylko wtedy, gdy --source.type jest ustawiona na wartość view.
update
Zaktualizuj właściwości dowolnej jednostki bazy danych w pliku konfiguracji.
Nuta
dab update obsługuje wszystkie opcje obsługiwane przez dab add. Ponadto obsługuje również wymienione opcje.
Składnia
dab update [entity-name] [options]
Przykłady
dab update Publisher --permissions "authenticated:*"
Opcje
| Opcje | Wymagana opcja | Wartość domyślna | Wymagana wartość | Typ wartości | Opis |
|---|---|---|---|---|---|
| — relacji | ❌ nie | ✔️ Tak | struna | Określ relację między dwiema jednostkami. Podaj nazwę relacji. | |
| — kardynalność | ✔️ Tak ¹ | ✔️ Tak | struna | Określ kardynalność między dwiema jednostkami. Może to być jeden lub wiele. | |
| --target.entity | ✔️ Tak ¹ | ✔️ Tak | struna | Inna uwidoczniona jednostka, z którą odnosi się jednostka źródłowa. | |
| --linking.object | ❌ nie | ✔️ Tak | struna | Obiekt bazy danych używany do obsługi relacji M:N. | |
| --linking.source.fields | ❌ nie | ✔️ Tak | struna | Pola bazy danych w obiekcie łączenia w celu nawiązania połączenia z powiązanym elementem w jednostce źródłowej. Pola rozdzielone przecinkami. | |
| --linking.target.fields | ❌ nie | ✔️ Tak | struna | Pola bazy danych w obiekcie łączenia w celu nawiązania połączenia z powiązanym elementem w jednostce docelowej. Pola rozdzielone przecinkami. | |
| --relationship.fields | ❌ nie | ✔️ Tak | struna | Określ pola, które mają być używane do mapowania jednostek. Przykład: --relationship.fields "id:book_id". W tym miejscu id reprezentuje kolumnę ze źródłaEntity, a book_id z targetEntity. Klucze obce są wymagane między źródłowymi źródłami, jeśli nie zostaną określone. |
|
| -m,--map | ❌ nie | ✔️ Tak | struna | Określ mapowania między polami bazy danych a polami GraphQL i REST. Format: --map "backendName1:exposedName1, backendName2:exposedName2,...". |
¹ Ta opcja jest wymagana tylko wtedy, gdy jest używana opcja --relationship.
export
Wyeksportuj wymagany schemat jako plik i zapisz go na dysku na podstawie opcji.
Składnia
dab export [options]
Przykłady
dab export --graphql -o ./schemas
Opcje
| Opcje | Wymagana opcja | Wartość domyślna | Wymagana wartość | Typ wartości | Opis |
|---|---|---|---|---|---|
| --graphql | ❌ nie | false |
❌ nie | Eksportuj schemat GraphQL. | |
| -o,--output | ✔️ Tak | ✔️ Tak | struna | Określ katalog do zapisania pliku schematu. | |
| -g,--graphql-schema-file | ❌ nie | schema.graphql |
✔️ Tak | struna | Określ nazwę pliku schematu Graphql. |
| -c,--config | ❌ nie | dab-config.json |
✔️ Tak | struna | Ścieżka do pliku konfiguracji. |
start
Uruchom aparat środowiska uruchomieniowego z udostępnionym plikiem konfiguracji służącym do obsługi żądań REST i GraphQL.
Składnia
dab start [options]
Przykłady
dab start
Opcje
| Opcje | Wymagana opcja | Wartość domyślna | Wymagana wartość | Typ wartości | Opis |
|---|---|---|---|---|---|
| --verbose | ❌ nie | ❌ nie | Określ poziom rejestrowania jako informacyjny. | ||
| --LogLevel | ❌ nie | Debug, gdy hostMode=developmentErrorError, gdy |
✔️ Tak | struna | Określ poziom rejestrowania jako podaną wartość. przykład: debugowanie, błąd, informacje itp. |
| --no-https-redirect | ❌ nie | ✔️ Tak | - | Wyłącza automatyczne przekierowania https. | |
| -c,--config | ❌ nie | dab-config.json |
✔️ Tak | struna | Ścieżka do pliku konfiguracji. |
Nuta
Nie można jednocześnie używać --verbose i --LogLevel. Aby uzyskać więcej informacji na temat różnych poziomów rejestrowania, zobacz .NET log levels.
validate
Sprawdza poprawność pliku konfiguracji środowiska uruchomieniowego używanego przez aparat środowiska uruchomieniowego konstruktora interfejsu API danych. Proces sprawdzania poprawności gwarantuje, że plik konfiguracji jest zgodny ze schematem i zawiera wszystkie wymagane informacje dotyczące prawidłowego działania aparatu środowiska uruchomieniowego.
Składnia
dab validate [options]
Przykłady
dab validate
Opcje
| Opcje | Wymagana opcja | Wartość domyślna | Wymagana wartość | Typ wartości | Opis |
|---|---|---|---|---|---|
| -c,--config | ❌ nie | dab-config.json |
✔️ Tak | struna | Ścieżka do pliku konfiguracji, który jest elementem docelowym weryfikacji. |
Powiązana zawartość
- dokumentacja usługi Functions
- Dokumentacja konfiguracji