From 7fe49b871afc90e218f863ea2041f513dcc8bf29 Mon Sep 17 00:00:00 2001 From: deedee Date: Thu, 22 Oct 2020 15:47:01 +0900 Subject: [PATCH] =?UTF-8?q?[README]=20=EB=B2=84=EC=A0=84=20=EB=B0=8F=20?= =?UTF-8?q?=EC=82=AC=EC=9A=A9=20=EB=B0=A9=EB=B2=95=20=EB=A7=A4=EB=89=B4?= =?UTF-8?q?=EC=96=BC=20=EC=B6=94=EA=B0=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 39 ++++++++++++++++++++++++++++++++++++++- package.json | 5 +++++ 2 files changed, 43 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7b7aafd..4258454 100644 --- a/README.md +++ b/README.md @@ -5,11 +5,48 @@ NodeJS용 아임포트 REST API Client 입니다. +## 버전정보 +최신 버전은 [v0.9.3](https://github.com/iamport/rest-client-nodejs/tree/v0.9.3)입니다. + ## 설치하기 +아래 명령어를 통해 `iamport-rest-client-nodejs`를 귀하의 nodeJS 프로젝트에 추가합니다. + +``` +$ npm install iamport-rest-client-nodejs ``` - $ npm install iamport-rest-client-nodejs + +## API 호출하기 +아래는 `iamport-rest-client-nodejs`를 활용해 은행 정보 조회 API를 호출하는 예제 코드입니다. + +```javascript +// 1. 아임포트 REST API 호출에 필요한 모듈을 불러옵니다. +import { Iamport, Request, Enum } from 'iamport-rest-client-nodejs'; +const { Banks } = Request; +const { BankCodeEnum } = Enum; + +// 2. 아임포트 객체를 생성합니다. 귀하의 API 정보는 아임포트 관리자페이지 > 시스템설정 > 내정보를 참고해주세요. +const iamport = new Iamport({ + apiKey: '귀하의_REST_API_KEY를_입력해주세요', + apiSecret: '귀하의_REST_API_SECRET_KEY를_입력해주세요', +}); + +// EX1. 모든 은행 정보를 조회합니다. +const getBanks = Banks.getBanks(); +getBanks.request(iamport) +.then(response => console.log('response: ', response.data)) +.catch(error => console.log('error: ', error.response.data)); + +// EX2. 특정 은행 정보를 조회합니다. +const getBank = Banks.getBank({ + code: BankCodeEnum.SC, +}); +await getBank.request(iamport) +.then(response => console.log('response: ', response.data)) +.catch(error => console.log('error: ', error.response.data)); + ``` + ## 테스트하기 프로젝트를 클론 받은 후 필요한 모듈을 설치합니다. yan example 명령어를 통해 테스트할 타깃, `REST API 키` 그리고 `REST API SECRET 키`를 입력합니다. diff --git a/package.json b/package.json index 76a9b4f..a669652 100644 --- a/package.json +++ b/package.json @@ -25,6 +25,11 @@ "rest-client", "iamport-rest-client" ], + "homepage": "https://github.com/iamport/rest-client-nodejs", + "repository": { + "type": "git", + "url": "https://github.com/iamport/rest-client-nodejs" + }, "dependencies": { "@types/node": "^12.7.5", "axios": "^0.19.0",