Wygeneruj lokalnego klienta
Publiczne pakiety dla języków Java, Python i Node.js nie zostały jeszcze opublikowane. Wygeneruj lokalnego klienta z wersjonowanego publicznego kontraktu za pomocą przypiętego polecenia pokazanego poniżej. Stała wersja generatora sprawia, że aktualizacje kontraktu są świadome.
Skonfiguruj żądania
Wykonuj wywołania z zaufanego serwera, odczytuj token dostępu ze środowiska i używaj adresu bazowego oraz limitów czasu pokazanych w przykładach. Nigdy nie umieszczaj tokenu w kodzie przeglądarki.
Pobierz listę zwierząt
Przykłady dla języków Java, Python i Node.js wykonują tę samą pierwszą operację za pomocą standardowych bibliotek platformy, dlatego nie wymagają nieopublikowanego pakietu.
Obsłuż błędy
Sprawdzaj status i treść odpowiedzi. Zachowaj identyfikator żądania na potrzeby kontaktu ze wsparciem, ale nigdy nie zapisuj tokenu dostępu w logach. Ponawiaj zapis lub generowanie diety tylko wtedy, gdy żądanie można bezpiecznie powtórzyć.
Wersja i źródło
Generuj klientów na podstawie publicznego pakietu OpenAPI. Przypnij wersje kontraktu i generatora w procesie budowania, aby aktualizacje były przeglądane i powtarzalne.
Java
curl --fail --silent --show-error https://api.barflab.io/openapi.yaml -o openapi.yaml
docker run --rm -v "$PWD:/local" openapitools/openapi-generator-cli:v7.24.0 generate \
-i /local/openapi.yaml -g java -o /local/generated/barflab-java \
--additional-properties=library=native
Java HTTP
var request = HttpRequest.newBuilder(URI.create(
"https://api.barflab.io/v1/pets"))
.header("Authorization", "Bearer " + System.getenv("BARFLAB_TOKEN"))
.header("Accept", "application/json")
.timeout(Duration.ofSeconds(30))
.GET()
.build();
var response = httpClient.send(request, BodyHandlers.ofString());
Python
curl --fail --silent --show-error https://api.barflab.io/openapi.yaml -o openapi.yaml
docker run --rm -v "$PWD:/local" openapitools/openapi-generator-cli:v7.24.0 generate \
-i /local/openapi.yaml -g python -o /local/generated/barflab-python
Python HTTP
import os
import urllib.request
request = urllib.request.Request(
"https://api.barflab.io/v1/pets",
headers={
"Authorization": f"Bearer {os.environ['BARFLAB_TOKEN']}",
"Accept": "application/json",
},
)
with urllib.request.urlopen(request, timeout=30) as response:
body = response.read()
Node.js
curl --fail --silent --show-error https://api.barflab.io/openapi.yaml -o openapi.yaml
docker run --rm -v "$PWD:/local" openapitools/openapi-generator-cli:v7.24.0 generate \
-i /local/openapi.yaml -g typescript-fetch -o /local/generated/barflab-node
Node.js HTTP
const response = await fetch(
"https://api.barflab.io/v1/pets",
{
headers: {
Authorization: `Bearer ${process.env.BARFLAB_TOKEN}`,
Accept: "application/json",
},
signal: AbortSignal.timeout(30_000),
},
);
const body = await response.json();
Identyfikator operacji
petsList