Aller au contenu
WoWDBAPI · documentation
Menu

APIOutils

Bibliothèques clientes : API de WoWDB

Les clients officiels de WoWDB, d’un seul fichier et sans dépendance, et la génération de clients par OpenAPI.

Voir en Markdown

Bibliothèques officielles#

Chaque client tient en un seul fichier sans dépendance : copiez-le dans votre projet. Tous suivent la même interface : une méthode par ressource, la pagination automatique (iterate), une erreur typée avec le code de l’API, et une nouvelle tentative après Retry-After sur un 429.

Bon à savoirCes bibliothèques ne sont pas (encore) publiées sur npm, PyPI, Packagist, RubyGems ou Maven : téléchargez-les ci-dessous, et vérifiez leur somme SHA-256. Le fichier SHA256SUMS les réunit (sha256sum -c SHA256SUMS).

Licence MIT (texte complet) : utilisez-les dans tout projet, y compris commercial, et modifiez-les librement, en gardant la mention de copyright et la licence, déjà incluses en fin de chaque fichier. Voir aussi les licences de la documentation et des données.

Avec un client officiel
import { WowDb } from "./wowdb.mjs";

const wowdb = new WowDb({ userAgent: "bot-de-ma-guilde/1.0" });
const lame = await wowdb.items.retrieve("classic", 5191);
console.log(lame.name, lame.weapon.dps);

for await (const dague of wowdb.items.iterate("classic", { type: "dagger", rogue: true })) {
  console.log(dague.name);
}

Téléchargements#

  • JavaScript / TypeScriptNavigateur, Node.js 18+, Deno, Bun (ESM)
    v1.0.0testé

    wowdb.mjs · 7,7 Kio · types : wowdb.d.ts

    SHA-256295aef98caa298117604291a3ffb4fd2b31b8d05b28a79b495300e05218d21e7

    TéléchargerLire le code

  • PythonPython 3.8+, bibliothèque standard
    v1.0.0testé

    wowdb.py · 7,7 Kio

    SHA-256de4da2b8dc7d7f8d8c865686ed1f0d49c4dbc7f3a626fdc1523ff603c4151379

    TéléchargerLire le code

  • PHPPHP 8.1+, extension json
    v1.0.0

    WowDb.php · 6,5 Kio

    SHA-256a80919370ebc59ae6d41a69415cdff9c4f3978c85595a66d8044df6d6a5cf9a1

    TéléchargerLire le code

  • RubyRuby 3.0+, bibliothèque standard
    v1.0.0

    wowdb.rb · 5,3 Kio

    SHA-2562a0b972dea33332406e930ea97bed7eab0559bfdb40bed971fea317d9a86b6bb

    TéléchargerLire le code

  • GoGo 1.18+, bibliothèque standard
    v1.0.0

    wowdb.go · 6,6 Kio

    SHA-256bc0eefd78abd54bbcb9d3b663888df007fb972f2e7d337a0bbbe0fa9e308c51c

    TéléchargerLire le code

  • JavaJava 11+, java.net.http, lecteur JSON intégré
    v1.0.0

    WowDb.java · 13,2 Kio

    SHA-2567229fa83f2e245465fe7f0082610f58435966f639f6c5ae8549f639babd77e47

    TéléchargerLire le code

  • C# / .NET.NET 8+, System.Text.Json
    v1.0.0

    WowDb.cs · 8,1 Kio

    SHA-256f70d0cc7af58ecac6bd48507b43e595052eb15af5aa38a6c53621efa8e8a3518

    TéléchargerLire le code

Les clients marqués « testé » sont exécutés contre l’API à chaque série de tests de WoWDB ; les autres suivent la même interface et les mêmes règles (erreurs, pagination, Retry-After). Un souci, une amélioration ? Dites-le sur le forum.

Générer un client depuis OpenAPI#

Pour un client typé dans un autre langage, ou avec vos conventions, générez-le depuis la spécification OpenAPI 3.1. Quelques générateurs connus :

LangageOutilCommande
TypeScript (types)openapi-typescriptnpx openapi-typescript https://api.wowdb.assemblee-defias.fr/v1/openapi.json -o wowdb.d.ts
TypeScript (client fetch)OpenAPI Generatoropenapi-generator-cli generate -i https://api.wowdb.assemblee-defias.fr/v1/openapi.json -g typescript-fetch -o wowdb-ts
Pythonopenapi-python-clientopenapi-python-client generate --url https://api.wowdb.assemblee-defias.fr/v1/openapi.json
Gooapi-codegenoapi-codegen -package wowdb -generate types,client openapi.json > wowdb.gen.go
JavaOpenAPI Generatoropenapi-generator-cli generate -i https://api.wowdb.assemblee-defias.fr/v1/openapi.json -g java -o wowdb-java
C#NSwagnswag openapi2csclient /input:https://api.wowdb.assemblee-defias.fr/v1/openapi.json /namespace:WowDb /output:WowDb.cs
PHPOpenAPI Generatoropenapi-generator-cli generate -i https://api.wowdb.assemblee-defias.fr/v1/openapi.json -g php -o wowdb-php
RubyOpenAPI Generatoropenapi-generator-cli generate -i https://api.wowdb.assemblee-defias.fr/v1/openapi.json -g ruby -o wowdb-ruby
RustOpenAPI Generatoropenapi-generator-cli generate -i https://api.wowdb.assemblee-defias.fr/v1/openapi.json -g rust -o wowdb-rust
Kotlin, Swift, Dart…OpenAPI Generatoropenapi-generator-cli list donne les 50 générateurs de clients
Bon à savoirPour oapi-codegen, téléchargez d’abord le fichier : curl -o openapi.json https://api.wowdb.assemblee-defias.fr/v1/openapi.json.

API de WoWDB des Défias, v1. Données du jeu © Blizzard Entertainment. Conditions d’usage · Markdown · llms.txt · OpenAPI