본 문서에서는 Sample로 제공되는 Mock API App을 Mock Server로 활용하는 방법을 설명합니다.
Index
Mock Server, Mock API는 무엇인가요?
•
Mock Server란 실제 서버처럼 API 응답을 주고 받을 수 있는 모의 서버이고, 여기서 사용하는 API가 Mock API 입니다.
•
Mock Server는 서버와 클라이언트 중 어느 한쪽이 구축되지 않은 상태에서 개발을 진행할 시, 양자간 소통할 API를 임의로 정의하여 빠르고 손쉽게 프로토타입 구축을 할 수 있습니다.
SyncTree Sample Mock API 사용하기
1) Mock API에서 사용할 임의의 JSON data 구성
•
현재 다음과 같은 구조로 구성된 임의의 JSON data가 MockAPI Sample App의 ‘user list section’에 변수 userList의 값으로 등록이 되어 있습니다.
{
"users": [
{
"id": 1,
"name": "Lee",
"role": "developer"
},
{
"id": 2,
"name": "Kim",
"role": "designer"
},
{
"id": 3,
"name": "Park",
"role": "engineer"
}
]
}
JSON
복사
•
JSON Data의 내용을 추가, 변경하여 작업은 가능합니다. 다만 key를 변경하거나 JSON 형식을 변경하게 될 경우, Mock API가 정상적으로 작동하지 않을 수 있으니 참고하시기 바랍니다.
{
"users": [
{
"id": 1,
"name": "Lee",
"role": "developer"
},
{
"id": 2,
"name": "Kim",
"role": "designer"
},
{
"id": 3,
"name": "Park",
"role": "engineer"
},
{
"id": 4,
"name": "Kang",
"role": "programmer"
}
]
}
JSON
복사
CASE 1) JSON Value 추가
{
"users": [
{
"id": 1,
"name": "Peter",
"role": "painter"
},
{
"id": 2,
"name": "Joseph",
"role": "singer"
},
{
"id": 3,
"name": "Paul",
"role": "dancer"
}
]
}
JSON
복사
CASE 2) JSON Value 변경
•
JSON Data 블록은 아래와 같이 변경합니다.
No. | 기능 |
1 | Make Block을 클릭하고 변경된 JSON Data를 넣어 새로운 블록을 만듭니다. |
2 | 기존의 블록을 지우고 새로 만들어진 블록을 연결합니다. |
Save / Build / Push
•
블록 작업을 한 후 Save와 Build를 해야 블록을 테스트할 수 있습니다.
•
end-point를 통해 Mock API를 활용하기 위해서는 Production까지 Push한 후 API Portal로 공개해야 합니다.
Mock API 소개
1) get user list
•
API Document
•
Test Case
2) get user detail
•
API Document
•
Test Case
3) create new user
•
API Document
•
Test Case
4) edit user detail
•
API Document
•
Test Case
5) delete user
•
API Document
•
Test Case
