Udostępnij za pośrednictwem

Biblioteka klienta szablonu platformy Azure dla języka JavaScript — wersja 1.0.0-beta.1

  • Artykuł

Ten projekt jest używany jako pakiet szablonu dla zestawu Azure SDK dla języka JavaScript. Ma ona na celu ułatwienie deweloperom zestawu Azure SDK uruchamiania nowych pakietów i udostępnia przykład organizowania kodu i dokumentacji biblioteki klienta dla usługi platformy Azure.

Wprowadzenie

Obecnie obsługiwane środowiska

Aby uzyskać więcej informacji, zobacz nasze zasady pomocy technicznej .

Wymagania wstępne

Zazwyczaj w tym miejscu należy umieścić polecenie powłoki w celu aprowizacji niezbędnych usług platformy Azure.

Instalowanie pakietu @azure/template

Zainstaluj bibliotekę klienta szablonu dla języka JavaScript za pomocą polecenia npm:

npm install @azure/template

Obsługa przeglądarki

Pakiet JavaScript

Aby użyć tej biblioteki klienta w przeglądarce, najpierw należy użyć narzędzia bundler. Aby uzyskać szczegółowe informacje o tym, jak to zrobić, zapoznaj się z naszą dokumentacją dotyczącą tworzenia pakietów.

CORS

Musisz skonfigurować reguły współużytkowania zasobów między źródłami (CORS, Cross-Origin Resource Sharing) dla konta magazynu, jeśli trzeba je opracowywać dla przeglądarek. Przejdź do Azure Portal i Eksplorator usługi Azure Storage, znajdź konto magazynu, utwórz nowe reguły CORS dla usług blob/queue/file/table.

Można na przykład utworzyć następujące ustawienia mechanizmu CORS na potrzeby debugowania. Należy jednak dokładnie dostosować ustawienia zgodnie z wymaganiami w środowisku produkcyjnym.

  • Dozwolone źródła: *
  • Dozwolone czasowniki: DELETE,GET,HEAD,MERGE,POST,OPTIONS,PUT
  • Dozwolone nagłówki: *
  • Uwidocznione nagłówki: *
  • Maksymalny wiek (w sekundach): 86400

Dalsze przykłady

Przykłady najwyższego poziomu zwykle obejmują takie elementy jak tworzenie i uwierzytelnianie głównego klienta. Jeśli twoja usługa obsługuje wiele metod uwierzytelniania (np. opartych na kluczach i usłudze Azure Active Directory), możesz nadać osobny przykład każdego z nich.

Kluczowe pojęcia

ConfigurationClient

Tutaj opisz swojego podstawowego klienta. Porozmawiaj o tym, jakie operacje może wykonać, i kiedy deweloper chce go użyć.

Dodatkowe przykłady

Utwórz sekcję dla każdej koncepcji usługi najwyższego poziomu, którą chcesz wyjaśnić.

Przykłady

Pierwszy przykład

Utwórz kilka przykładów kodu, aby dowiedzieć się, jak ktoś użyje biblioteki do wykonania typowego zadania w usłudze.

Rozwiązywanie problemów

Rejestrowanie

Włączenie rejestrowania może pomóc odkryć przydatne informacje o błędach. Aby wyświetlić dziennik żądań i odpowiedzi HTTP, ustaw zmienną AZURE_LOG_LEVEL środowiskową na info. Alternatywnie rejestrowanie można włączyć w czasie wykonywania, wywołując setLogLevel polecenie w pliku @azure/logger:

const { setLogLevel } = require("@azure/logger");

setLogLevel("info");

Aby uzyskać bardziej szczegółowe instrukcje dotyczące włączania dzienników, zapoznaj się z dokumentami dotyczącymi pakietów @azure/rejestratora.

Następne kroki

Zapoznaj się z katalogiem samples , aby zapoznać się ze szczegółowymi przykładami, które pokazują, jak używać bibliotek klienckich.

Współtworzenie

Jeśli chcesz współtworzyć tę bibliotekę, przeczytaj przewodnik współtworzenia , aby dowiedzieć się więcej na temat tworzenia i testowania kodu.

Wrażenia