다음을 통해 공유

SDK 생성기 빠른 시작

  • 아티클

SDK 생성기는 PlayFab API의 JSON 설명을 가져오고 이를 사용하여 최신으로 유지되어야 하는 모든 다른 SDK를 생성하는 node.js 기반 프로그램입니다. SDK 생성기 프로젝트에는 모든 플랫폼의 모든 PlayFab SDK에 대한 소스도 포함됩니다. SDK에서 변경을 적용하려는 경우 여기에서 변경해야 합니다.

PlayFab API를 호출하려면 먼저 PlayFab 개발자 계정이 있어야 합니다.

필수 조건

  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에는 SdkGenerator와 형제 폴더로 로컬 머신에 복제한 여러 PlayFab 리포지토리가 필요합니다.
    • <parent-folder>/SdkGenerator = <https://github.com/PlayFab/SDKGenerator>(현재 표시됨)
    • <parent-folder>/sdks/<targetSDK> - 생성하려는 모든 SDK에 대해 해당 대상에 대한 PlayFab 리포지토리를 먼저 ‘sdks’ 하위 폴더로 git 복제해야 합니다. 대부분의 경우에는 생성되지 않는 필요한 파일이 리포지토리에 있습니다.
  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와 일치하는 스크립트를 찾습니다(예: unity_build.bat).
  • 해당 파일을 두 번 클릭합니다.

새 SDK를 빌드하려는 경우 다음 섹션의 지침에 따라 새 .bat 파일을 빌드해야 할 수 있습니다.

마지막으로 생성할 대상 목록 및 이를 생성할 디렉터리를 제공해야 합니다.

수동으로 생성기를 호출하려면 프로젝트의 루트에서 명령줄을 열고 대상에 입력합니다. 각 대상의 형식은 다음과 같습니다.

<targetName>=<targetOutputLocation>

여기에서 <targetName>은 지원되는 SDK 대상 중 하나이며 <targetOutputLocation>은 SDK를 생성할 디렉터리의 경로입니다.

참고 항목

인수와 등호 사이에 공백이 없도록 합니다.

API-Spec 위치

  • 선택적으로 정확히 하나의 위치를 정의하여 API-Spec 정보를 읽을 수 있습니다.
    • -apiSpecPath []
      • -apiSpecPath 스위치가 경로 없이 정의되면 기본값이 ../API_Specs가 됩니다(상대 경로, SdkGenerator 리포지토리 위치의 형제).
    • -apiSpecGitUrl []
      • -apiSpecGitUrl 스위치가 URL 없이 정의되는 경우 기본값: <https://raw.githubusercontent.com/PlayFab/API_Specs/master/>
      • GitHub 리포지토리에서 직접 API_Specs를 읽습니다.
    • -apiSpecPfUrl []
      • -apiSpecPfUrl 스위치가 URL 없이 정의되는 경우 기본값: <https://www.playfabapi.com/apispec/>
      • PlayFab API 서버에서 직접 API_Specs를 읽습니다.

플래그는 선택 사항이며, 콘솔 API를 생성하는 데 사용할 수 있습니다.

새로운 SDK 빌드

SdkGenerator에서 새 대상을 설정하는 것은 매우 간단합니다. 이 예제는 참조를 위해 SdkGenerator에 추가 되었습니다(https://github.com/PlayFab/SDKGenerator/tree/master/targets/newTarget).

  • SdkGenerator/Targets에 새 하위 폴더를 추가합니다.
  • 새 대상에 “make.js” 파일을 추가합니다.
    • NewTarget 예제와 같이 파일에 makeClientAPI2, makeServerAPI 및/또는 makeCombinedAPI를 구현합니다.
    • 필요에 따라 NewTarget 예제에 설명된 대로 템플릿 파일 및 소스 파일을 사용할 수 있습니다.
  • SdkGenerator/SDKBuildScripts에서 sdk를 생성할 새 bat 파일을 추가합니다.

PlayFab은 때때로 새로운 SDK에 대한 제출을 허용합니다. 이 프로세스는 광범위하며 자동화된 빌드 및 테스트 시스템과 통합되어야 합니다. 자세한 내용은 포럼에서 직접 문의하세요.

문제 해결

사용 가능한 전체 API 목록은 API 참조를 확인하세요.

문의하기

개발자 커뮤니티의 의견을 듣고 싶습니다! 제품 및 서비스를 개선할 수 있는 방법에 대해 의견이 있으신가요?

개발자 성공 팀은 모든 질문에 응답하고 PlayFab 서비스에 대한 피드백을 처리하는 것을 돕습니다.

포럼, 지원 및 기술 자료