Skip to content

Commit

Permalink
[README] 버전 및 사용 방법 매뉴얼 추가
Browse files Browse the repository at this point in the history
  • Loading branch information
SoleeChoi committed Oct 22, 2020
1 parent 4682bd0 commit 7fe49b8
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 1 deletion.
39 changes: 38 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 키`를 입력합니다.

Expand Down
5 changes: 5 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down

0 comments on commit 7fe49b8

Please sign in to comment.