Vygenerujte místního klienta
Veřejné balíčky pro Javu, Python ani Node.js zatím nejsou publikovány. Vygenerujte místního klienta z verzovaného veřejného kontraktu pomocí níže uvedeného příkazu s pevně určenou verzí generátoru. Udržování pevné verze generátoru umožňuje plánované aktualizace kontraktu.
Nastavte požadavky
Volání provádějte z důvěryhodného serveru, přístupový token načítejte z prostředí a používejte základní adresu a časové limity uvedené v příkladech. Token nikdy nevkládejte do kódu prohlížeče.
Vypište zvířata
Níže uvedené příklady v Javě, Pythonu a Node.js provádějí stejnou první operaci pomocí standardních knihoven platformy, takže nezávisí na nepublikovaném balíčku.
Práce s chybami
Kontrolujte stav i tělo odpovědi. Identifikátor požadavku si ponechte pro případný kontakt s podporou, ale přístupový token nikdy nezapisujte do protokolů. Zápis nebo generování diety opakujte pouze tehdy, když lze požadavek bezpečně zopakovat.
Verze a zdroj
Klienty generujte z veřejného balíčku OpenAPI. Ve svém sestavení pevně určete verzi kontraktu i generátoru, aby aktualizace byly kontrolovatelné a opakovatelné.
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();