SDK Generator 快速入门

  • 项目

SDK 生成器是基于 node.js 的程序，它采用 PlayFab API 的 JSON 说明，并使用它来生成必须保持最新状态的所有不同 SDK。 SDK 生成器项目还包含所有平台上所有 PlayFab SDK 的源。 如果要在 SDK 中进行更改，必须在此进行更改。

必须有 PlayFab 开发者帐户才能调用 PlayFab API。

先决条件

  1. 任何最近的 MS-Windows 操作系统。
  2. 必须安装 Node.js: https://nodejs.org/
    • node.exe 的位置必须位于 PATH 环境变量中。 默认位置：C:\Program Files (x86)\nodejs\
    • 强烈建议你安装针对 Visual Studio 的 Node.js 工具：https://beta.visualstudio.com/vs/node-js/。
  3. SdkGenerator 需要多个 PlayFab 存储库(克隆到本地计算机)作为同级文件夹来 SdkGenerator。
    • <parent-folder>/SdkGenerator = <https://github.com/PlayFab/SDKGenerator>(要查找的内容)
    • <parent-folder>/sdks/<targetSDK> - 对于要生成的每个 SDK，应先将该目标的 PlayFab 存储库克隆到“sdks”子文件夹中。 在许多情况下，存储库中会有一些不会生成的必需文件。
  4. SdkGenerator 可以配置为从其他 PlayFab 存储库读取，克隆到本地计算机，作为 SdkGenerator 的同级文件夹。
    • <parent-folder>/API_Specs = <https://github.com/PlayFab/api_specs>

使用说明

如果已安装 Node.js 工具，则可从 Visual Studio 解决方案构建任何现有的 SDK：https://github.com/PlayFab/SDKGenerator/blob/master/SDKGenerator.sln

  • 打开解决方案。
  • 设置项目配置以匹配要生成的 SDK。
  • 生成 ->生成解决方案。

有许多预构建的脚本可以自动构建每个 SDK：https://github.com/PlayFab/SDKGenerator/tree/master/SDKBuildScripts

  • 找到与要构建的 SDK 匹配的脚本 (EX unity_build.bat)。
  • 双击此文件。

如果要生成新的 SDK，可能需要使用下一部分中的说明生成新的 .bat 文件。

最后，必须提供要生成的目标列表以及将它们生成到哪个目录中。

要手动调用生成器，请在项目的根目录中打开命令行并键入目标。 每个目标都采用以下形式：

<targetName>=<targetOutputLocation>

其中 <targetName> 是支持的 SDK 目标之一，<targetOutputLocation> 是要在其中生成 SDK 的目录的路径。

注意

确保参数与等号之间没有空格。

API-Spec 位置

  • 可以选择只定义一个位置来读取 API 规范信息。
    • -apiSpecPath []
      • 如果定义了 -apiSpecPath 开关但未指定路径，则默认为 ../API_Specs（相对路径，与 SdkGenerator 存储库位置同级）。
    • -apiSpecGitUrl []
      • 如果未使用 URL 定义 -apiSpecGitUrl 开关，则默认为 <https://raw.githubusercontent.com/PlayFab/API_Specs/master/>
      • 直接从 GitHub 存储库读取 API_Specs。
    • -apiSpecPfUrl []
      • 如果未使用 URL 定义 -apiSpecPfUrl 开关，则默认为 <https://www.playfabapi.com/apispec/>
      • 直接从 PlayFab API 服务器读取 API_Spec。

标志是可选的，可用于生成控制台 API。

构建新的 SDK

在 SdkGenerator 中设置新目标非常简单。 已将此示例添加到 SdkGenerator 以供参考：https://github.com/PlayFab/SDKGenerator/tree/master/targets/newTarget。

  • 在 SdkGenerator/Targets 中添加新的子文件夹。
  • 将“make.js”文件添加到新目标中。
    • 在文件中实现 makeClientAPI2、makeServerAPI 和/或 makeCombinedAPI，如 NewTarget 示例中所示。
    • 或者，可以使用模板文件和源文件，如 NewTarget 示例中所述。
  • 添加一个新的 bat 文件以在 SdkGenerator/SDKBuildScripts 中生成你的 SDK。

PlayFab 有时会接受新 SDK 的提交。 此过程非常广泛，必须与我们的自动构建和测试系统集成。 有关详细信息，请通过论坛与我们联系。

疑难解答

有关可用 API 的完整列表，请查看 API 参考。

联系我们

我们很乐意听取开发者社区的意见！ 是否有关于如何改进我们产品和服务的建议？

我们的开发者成功团队可以协助回答任何问题，并处理关于 PlayFab 服务的任何反馈。

论坛、支持和知识库