Passer au contenu principal
Le SDK Generator est un programme basé sur node.js qui utilise une description JSON de l’API PlayFab pour générer tous les différents SDK qui doivent être maintenus à jour. Le projet SDK Generator contient également les sources de tous les SDK PlayFab pour toutes les plateformes. Si vous souhaitez apporter une modification à un SDK, c’est ici qu’elle doit être effectuée. Avant de pouvoir appeler une API PlayFab, vous devez disposer d’un compte de développeur PlayFab.

​
Prérequis

  1. N’importe quel système d’exploitation MS-Windows récent.
  2. Node.js doit être installé : https://nodejs.org/
    • L’emplacement de node.exe doit figurer dans votre variable d’environnement PATH. Par défaut : C:\Program Files (x86)\nodejs\
    • Il est vivement recommandé d’installer les outils Node.js pour Visual Studio : https://beta.visualstudio.com/vs/node-js/.
  3. SdkGenerator nécessite plusieurs dépôts PlayFab, clonés sur votre ordinateur local, en tant que dossiers frères de SdkGenerator.
    • <parent-folder>/SdkGenerator = <https://github.com/PlayFab/SDKGenerator> (celui que vous consultez)
    • <parent-folder>/sdks/<targetSDK> : pour chaque SDK que vous souhaitez générer, vous devez d’abord cloner avec git le dépôt PlayFab de cette cible dans le sous-dossier « sdks ». Dans de nombreux cas, le dépôt contient des fichiers requis qui ne sont pas générés.
  4. SdkGenerator peut être configuré pour lire d’autres dépôts PlayFab, clonés sur votre ordinateur local, en tant que dossiers frères de SdkGenerator.
    • <parent-folder>/API_Specs = <https://github.com/PlayFab/api_specs>

​
Instructions d’utilisation

Si vous avez installé les outils Node.js, vous pouvez générer n’importe quel SDK existant à partir de la solution Visual Studio : https://github.com/PlayFab/SDKGenerator/blob/master/SDKGenerator.sln
  • Ouvrez la solution.
  • Définissez la configuration du projet pour qu’elle corresponde au SDK que vous souhaitez générer.
  • Build -> Build Solution.
De nombreux scripts prédéfinis permettent de générer automatiquement chaque SDK : https://github.com/PlayFab/SDKGenerator/tree/master/SDKBuildScripts
  • Recherchez le script correspondant au SDK que vous souhaitez générer (par exemple unity_build.bat).
  • Double-cliquez sur ce fichier.
Si vous souhaitez générer un nouveau SDK, vous devrez peut-être créer un nouveau fichier .bat en suivant les instructions de la section suivante. Enfin, vous devez fournir la liste des cibles à générer et le répertoire dans lequel les générer. Pour appeler manuellement le générateur, ouvrez une ligne de commande à la racine du projet et saisissez une cible. Chaque cible se présente sous la forme : <targetName>=<targetOutputLocation> Où <targetName> est l’une des cibles SDK prises en charge et <targetOutputLocation> est le chemin d’un répertoire dans lequel générer le SDK.
Assurez-vous qu’il n’y a pas d’espace entre les arguments et le signe égal.

​
Emplacement de l’API-Spec

  • Vous pouvez éventuellement définir un seul emplacement à partir duquel lire les informations de l’API-Spec.
    • -apiSpecPath []
      • Si le commutateur -apiSpecPath est défini sans chemin, la valeur par défaut est ../API_Specs (chemin relatif, dossier frère de l’emplacement du dépôt SdkGenerator).
    • -apiSpecGitUrl []
      • Si le commutateur -apiSpecGitUrl est défini sans URL, la valeur par défaut est <https://raw.githubusercontent.com/PlayFab/API_Specs/master/>
      • Lit les API_Specs directement depuis un dépôt GitHub.
    • -apiSpecPfUrl []
      • Si le commutateur -apiSpecPfUrl est défini sans URL, la valeur par défaut est <https://www.playfabapi.com/apispec/>
      • Lit les API_Specs directement depuis le serveur d’API PlayFab.
Les indicateurs sont facultatifs et peuvent être utilisés pour générer des API de console.

​
Création d’un nouveau SDK

La configuration d’une nouvelle cible dans le SdkGenerator est assez simple. Cet exemple a été ajouté au SdkGenerator à titre de référence : https://github.com/PlayFab/SDKGenerator/tree/master/targets/newTarget.
  • Ajoutez un nouveau sous-dossier dans SdkGenerator/Targets.
  • Ajoutez un fichier « make.js » à votre nouvelle cible.
    • Implémentez makeClientAPI2, makeServerAPI et/ou makeCombinedAPI dans le fichier, comme illustré dans l’exemple NewTarget.
    • Vous pouvez éventuellement utiliser des fichiers modèles et des fichiers sources, comme décrit dans l’exemple NewTarget.
  • Ajoutez un nouveau fichier bat pour générer votre SDK dans SdkGenerator/SDKBuildScripts.
PlayFab accepte parfois des propositions de nouveaux SDK. Ce processus est complexe et doit être intégré à notre système automatisé de génération et de test. Pour plus d’informations, contactez-nous sur les forums.

​
Résolution des problèmes

Pour obtenir la liste complète des API disponibles, consultez les Références de l’API.

​
Nous contacter

Nous aimons recevoir des nouvelles de notre communauté de développeurs ! Vous avez des idées pour améliorer nos produits et services ? Notre équipe Developer Success peut répondre à toutes vos questions et traiter tous vos commentaires sur les services PlayFab. Forums, support et base de connaissances
Dernière modification le 8 octobre 2026