From fb858b01d4cc82b9d4f1439e978815935cdc1772 Mon Sep 17 00:00:00 2001 From: kiwiyou Date: Wed, 16 Oct 2024 12:18:21 +0900 Subject: [PATCH 1/3] feat: add v2-server-sdk/readme --- src/routes/(root)/opi/ko/_nav.yaml | 5 + .../ko/integration/v2-server-sdk/readme.mdx | 93 +++++++++++++++++++ 2 files changed, 98 insertions(+) create mode 100644 src/routes/(root)/opi/ko/integration/v2-server-sdk/readme.mdx diff --git a/src/routes/(root)/opi/ko/_nav.yaml b/src/routes/(root)/opi/ko/_nav.yaml index 4ca613118..d5abe5d7b 100644 --- a/src/routes/(root)/opi/ko/_nav.yaml +++ b/src/routes/(root)/opi/ko/_nav.yaml @@ -61,6 +61,11 @@ items: - /ko/integration/v2-mobile-sdk/readme +- label: 서버 SDK + systemVersion: v2 + items: + - /ko/integration/v2-server-sdk/readme + - label: 결제 연동하기 systemVersion: v1 items: diff --git a/src/routes/(root)/opi/ko/integration/v2-server-sdk/readme.mdx b/src/routes/(root)/opi/ko/integration/v2-server-sdk/readme.mdx new file mode 100644 index 000000000..041d0ec0c --- /dev/null +++ b/src/routes/(root)/opi/ko/integration/v2-server-sdk/readme.mdx @@ -0,0 +1,93 @@ +--- +title: 서버 SDK 레퍼런스 +description: 웹훅 및 REST API 연동시 사용되는 SDK에 대한 설명 문서입니다. +targetVersions: ["v2"] +--- + +import Tabs from "~/components/gitbook/Tabs"; + +포트원 서버 SDK는 웹훅을 포함한 포트원 V2 REST API를 여러 언어에서 별도의 보일러플레이트 없이 사용 가능하도록 만들어진 SDK입니다. + +현재 Javascript 및 Typescript, Python, JVM을 지원하고 있으며, Go, PHP 등을 지원할 예정입니다. + +## Javascript 및 Typescript + +- [GitHub 레포지토리](https://github.com/portone-io/server-sdk/tree/main/javascript) +- [API 레퍼런스](https://portone-io.github.io/server-sdk/js) + +Javascript 및 Typescript SDK는 [npm](https://www.npmjs.com/package/@portone/server-sdk)과 [jsr](https://jsr.io/@portone/server-sdk)을 통해 배포되고 있습니다. +`@portone/server-sdk` 패키지를 의존성에 추가하여 사용하실 수 있습니다. + +Node.js의 경우 v20 이상에서 정상 동작하며, v20 미만 버전은 폴리필이 필요합니다. + + + + 애플리케이션 코드 시작 부분에 아래 코드를 삽입해 주세요. + + ```javascript title="CommonJS" + globalThis.crypto = require("node:crypto").webcrypto; + ``` + + ```javascript title="ESM" + import { webcrypto } from "node:crypto"; + globalThis.crypto = webcrypto; + ``` + + + + [@whatwg-node/fetch](https://www.npmjs.com/package/@whatwg-node/fetch) 패키지를 의존성에 추가해 주세요. + + 애플리케이션 코드 시작 부분에 아래 코드를 삽입해 주세요. + + ```javascript title="CommonJS" + const { fetch, crypto } = require("@whatwg-node/fetch"); + globalThis.fetch = fetch; + globalThis.crypto = crypto; + ``` + + ```javascript title="ESM" + import { crypto, fetch } from "@whatwg-node/fetch"; + globalThis.fetch = fetch; + globalThis.crypto = crypto; + ``` + + + +## Python + +- [GitHub 레포지토리](https://github.com/portone-io/server-sdk/tree/main/python) +- [API 레퍼런스](https://portone-io.github.io/server-sdk/py) + +Python SDK는 [PyPI](https://pypi.org/project/portone-server-sdk)를 통해 배포되고 있습니다. +`portone-server-sdk` 패키지를 의존성에 추가하여 사용하실 수 있습니다. + +Python 3.9 이상에서 정상 동작합니다. + +## JVM + +- [GitHub 레포지토리](https://github.com/portone-io/server-sdk/tree/main/jvm) +- [API 레퍼런스](https://portone-io.github.io/server-sdk/jvm) + +Java, Kotlin, Scala 등에서 사용 가능한 JVM SDK는 [Maven](https://central.sonatype.com/artifact/io.portone/server-sdk)을 통해 배포되고 있습니다. + +`io.portone:server-sdk` 패키지를 의존성에 추가하여 사용하실 수 있습니다. + +```xml title="Apache Maven" + + io.portone + server-sdk + 0.3.0 + +``` + +```groovy title="Gradle (Groovy)" +implementation group: 'io.portone', name: 'server-sdk', version: '0.3.0' +``` + +```kotlin title="Gradle (Kotlin)" +implementation("io.portone:server-sdk:0.3.0") +``` + +```scala title="sbt" +libraryDependencies += "io.portone" % "server-sdk" % "0.3.0" +``` From 301ebaff8c29b688bf5aae53f193c55b6f1cf17e Mon Sep 17 00:00:00 2001 From: kiwiyou Date: Wed, 16 Oct 2024 12:39:03 +0900 Subject: [PATCH 2/3] fix: js/ts case --- .../(root)/opi/ko/integration/v2-server-sdk/readme.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/routes/(root)/opi/ko/integration/v2-server-sdk/readme.mdx b/src/routes/(root)/opi/ko/integration/v2-server-sdk/readme.mdx index 041d0ec0c..53a54906e 100644 --- a/src/routes/(root)/opi/ko/integration/v2-server-sdk/readme.mdx +++ b/src/routes/(root)/opi/ko/integration/v2-server-sdk/readme.mdx @@ -8,14 +8,14 @@ import Tabs from "~/components/gitbook/Tabs"; 포트원 서버 SDK는 웹훅을 포함한 포트원 V2 REST API를 여러 언어에서 별도의 보일러플레이트 없이 사용 가능하도록 만들어진 SDK입니다. -현재 Javascript 및 Typescript, Python, JVM을 지원하고 있으며, Go, PHP 등을 지원할 예정입니다. +현재 JavaScript 및 TypeScript, Python, JVM을 지원하고 있으며, Go, PHP 등을 지원할 예정입니다. -## Javascript 및 Typescript +## JavaScript 및 TypeScript - [GitHub 레포지토리](https://github.com/portone-io/server-sdk/tree/main/javascript) - [API 레퍼런스](https://portone-io.github.io/server-sdk/js) -Javascript 및 Typescript SDK는 [npm](https://www.npmjs.com/package/@portone/server-sdk)과 [jsr](https://jsr.io/@portone/server-sdk)을 통해 배포되고 있습니다. +JavaScript 및 TypeScript SDK는 [npm](https://www.npmjs.com/package/@portone/server-sdk)과 [jsr](https://jsr.io/@portone/server-sdk)을 통해 배포되고 있습니다. `@portone/server-sdk` 패키지를 의존성에 추가하여 사용하실 수 있습니다. Node.js의 경우 v20 이상에서 정상 동작하며, v20 미만 버전은 폴리필이 필요합니다. From 916542edadb68d3e62c06b1d6edc809254356c6e Mon Sep 17 00:00:00 2001 From: kiwiyou Date: Thu, 17 Oct 2024 12:50:48 +0900 Subject: [PATCH 3/3] fix: use short groovy --- .../(root)/opi/ko/integration/v2-server-sdk/readme.mdx | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/routes/(root)/opi/ko/integration/v2-server-sdk/readme.mdx b/src/routes/(root)/opi/ko/integration/v2-server-sdk/readme.mdx index 53a54906e..2cc57981d 100644 --- a/src/routes/(root)/opi/ko/integration/v2-server-sdk/readme.mdx +++ b/src/routes/(root)/opi/ko/integration/v2-server-sdk/readme.mdx @@ -80,14 +80,14 @@ Java, Kotlin, Scala 등에서 사용 가능한 JVM SDK는 [Maven](https://centra ``` -```groovy title="Gradle (Groovy)" -implementation group: 'io.portone', name: 'server-sdk', version: '0.3.0' -``` - ```kotlin title="Gradle (Kotlin)" implementation("io.portone:server-sdk:0.3.0") ``` +```groovy title="Gradle (Groovy)" +implementation 'io.portone:server-sdk:0.3.0' +``` + ```scala title="sbt" libraryDependencies += "io.portone" % "server-sdk" % "0.3.0" ```