Freigeben über

Schnellstart: SDK-Generator

  • Artikel

Der SDK-Generator ist ein node.js-basiertes Programm, das eine JSON-Beschreibung der PlayFab-API verwendet, um alle verschiedenen SDKs zu generieren, die auf dem neuesten Stand gehalten werden müssen. Das SDK-Generator-Projekt enthält auch die Quellen für alle PlayFab SDKs auf allen Plattformen. Wenn Sie eine Änderung in einem SDK vornehmen möchten, muss die Änderung an dieser Stelle ausgeführt werden.

Bevor Sie eine PlayFab-API aufrufen können, müssen Sie über ein PlayFab-Entwicklerkonto verfügen.

Voraussetzungen

  1. Alle aktuellen MS-Windows Betriebssystem.
  2. Sie müssen Node.js installiert haben: https://nodejs.org/
    • Der Speicherort von node.exe muss sich in Ihrer PATH-Umgebungsvariablen befinden. Standard: C:\Programme (x86)\nodejs\
    • Es wird dringend empfohlen, Node.js Tools für Visual Studio zu installieren: https://beta.visualstudio.com/vs/node-js/.
  3. SdkGenerator erfordert mehrere PlayFab-Repositorys, die auf Ihren lokalen Computer geklont werden, als gleichgeordnete Ordner für SdkGenerator.
    • <parent-folder>/SdkGenerator = <https://github.com/PlayFab/SDKGenerator> (Sie sehen es sich an)
    • <parent-folder>/sdks/<targetSDK> – Für jedes SDK, das Sie generieren möchten, sollten Sie zuerst das PlayFab-Repository für dieses Ziel in den Unterordner "sdks" klonen. In vielen Fällen sind im Repository erforderliche Dateien vorhanden, die nicht generiert werden.
  4. SdkGenerator kann so konfiguriert werden, dass aus anderen PlayFab-Repositorys gelesen wird, die auf Ihren lokalen Computer geklont werden, als gleichgeordnete Ordner für SdkGenerator.
    • <parent-folder>/API_Specs = <https://github.com/PlayFab/api_specs>

Verwendungsanweisungen

Wenn Sie Node.js Tools installiert haben, können Sie jedes vorhandene SDK aus der Visual Studio-Projektmappe erstellen: https://github.com/PlayFab/SDKGenerator/blob/master/SDKGenerator.sln

  • Öffnen Sie die Projektmappe.
  • Legen Sie die Projektkonfiguration so fest, dass sie dem SDK entspricht, das Sie erstellen möchten.
  • Build ->Projektmappe erstellen.

Es gibt viele vordefinierte Skripts, die jedes SDK automatisch erstellen können: https://github.com/PlayFab/SDKGenerator/tree/master/SDKBuildScripts

  • Suchen Sie das Skript, das mit dem SDK übereinstimmt, das Sie erstellen möchten (EX-unity_build.bat).
  • Doppelklicken Sie auf diese Datei.

Wenn Sie ein neues SDK erstellen möchten, müssen Sie möglicherweise mithilfe der Anweisungen im nächsten Abschnitt eine neue .bat-Datei erstellen.

Schließlich müssen Sie eine Liste der zu generierenden Ziele und das Verzeichnis angeben, in dem sie generiert werden sollen.

Um den Generator manuell aufzurufen, öffnen Sie eine Befehlszeile im Stammverzeichnis des Projekts, und geben Sie ein Ziel ein. Jedes Ziel hat die folgende Form:

<targetName>=<targetOutputLocation>

Dabei <targetName> ist eines der unterstützten SDK-Ziele und <targetOutputLocation> ein Pfad zu einem Verzeichnis, in dem das SDK generiert werden soll.

Notiz

Stellen Sie sicher, dass zwischen den Argumenten und dem Gleichheitszeichen keine Leerzeichen vorhanden sind.

API-Spec Standort

  • Optional können Sie genau einen Speicherort definieren, um API-Spec Informationen zu lesen.
    • -apiSpecPath []
      • Wenn der -apiSpecPath Switch ohne Pfad definiert ist, wird standardmäßig (relativer Pfad, gleichgeordneter Speicherort des SdkGenerator-Repositorys ../API_Specs ) verwendet.
    • -apiSpecGitUrl []
      • Wenn der -apiSpecGitUrl Schalter ohne URL definiert ist, wird standardmäßig auf <https://raw.githubusercontent.com/PlayFab/API_Specs/master/>
      • Liest API_Specs direkt aus einem GitHub-Repository.
    • -apiSpecPfUrl []
      • Wenn der -apiSpecPfUrl Schalter ohne URL definiert ist, wird standardmäßig auf <https://www.playfabapi.com/apispec/>
      • Liest API_Specs direkt aus dem PlayFab-API-Server.

Flags sind optional und können zum Generieren von Konsolen-APIs verwendet werden.

Erstellen eines neuen SDK

Das Einrichten eines neuen Ziels in ist SdkGenerator relativ einfach. Dieses Beispiel wurde zu SdkGenerator Referenzzwecken hinzugefügt: https://github.com/PlayFab/SDKGenerator/tree/master/targets/newTarget.

  • Fügen Sie einen neuen Unterordner in SdkGenerator/Targets hinzu.
  • Fügen Sie dem neuen Ziel eine "make.js"-Datei hinzu.
    • Implementieren Sie makeClientAPI2, makeServerAPIund/oder makeCombinedAPI in der Datei, wie im NewTarget-Beispiel gezeigt.
    • Optional können Sie Vorlagendateien und Quelldateien verwenden, wie im NewTarget-Beispiel beschrieben.
  • Fügen Sie eine neue Bat-Datei hinzu, um Ihr SDK in SdkGenerator/SDKBuildScripts zu generieren.

PlayFab akzeptiert manchmal Übermittlungen für neue SDKs. Dieser Prozess ist umfangreich und muss in unser automatisiertes Build- und Testsystem integriert werden. Für weitere Informationen kontaktieren Sie uns in den Foren.

Problembehandlung

Eine vollständige Liste der verfügbaren APIs finden Sie unter API-Verweise.

So erreichen Sie uns

Wir freuen uns, von unserer Entwicklercommunity zu hören! Haben Sie Ideen, wie wir unsere Produkte und Dienstleistungen verbessern können?

Unser Entwicklererfolgsteam kann Ihnen bei der Beantwortung von Fragen helfen und Ihr Feedback zu PlayFab-Diensten verarbeiten.

Foren, Support und Wissensdatenbank