Breaker (Server)

Koa, MongoDB를 사용한 API 서버이며 HRetan/Breaker 게임 개발 프로젝트의 API 서버입니다.

Features

• GET /api/maps
• POST /api/maps
• GET /api/maps/:id
• DELETE /api/maps/:id
• PUT /api/maps/:id

Map 리스트 조회

GET /api/maps?owner={owner}

param은 생략가능하며, owner 입력시 해당 user에 대한 리스트만 조회합니다.

Response

GET /api/maps

{
        "_id": "5c4ffb83484f0349341a1e32",
        "title": "retan Title1",
        "owner": "retan",
        "__v": 0
},
{
        "_id": "5c4ffb83484f0349341a1e33",
        "title": "retan Title2",
        "owner": "retan",
        "__v": 0
},
{
        "_id": "5c4ffb83484f0349341a1e34",
        "title": "lucas Title1",
        "owner": "lucas",
        "__v": 0
},
(...)

GET /api/maps?owner=lucas

{
        "_id": "5c4ffb83484f0349341a1e48",
        "title": "lucas Title1",
        "owner": "lucas",
        "__v": 0
},
{
        "_id": "5c4ffb83484f0349341a1e49",
        "title": "lucas Title2",
        "owner": "lucas",
        "__v": 0
},
(...)

Map 정보 업로드

POST /api/maps

Request Body

POST /api/maps

{
    "title": "delete test",
    "owner": "lucas",
    "mapData": [
        {
            "blockID": 10,
            "iIndex": 68
        },
        {
            "blockID": 10,
            "iIndex": 94
        }
    ],
    "password": "password"
}

Request body에 포함되지 않는 field는 자동으로 채워집니다.

Response

POST /api/maps

{
    "bestScore": {
        "user": "uknown",
        "score": 0
    },
    "count": 0,
    "createDate": "2019-01-29T07:28:15.947Z",
    "_id": "5c50070c10449e45ec4beaa4",
    "title": "delete test",
    "owner": "lucas",
    "mapData": [
        {
            "_id": "5c50070c10449e45ec4beaa6",
            "blockID": 10,
            "iIndex": 68
        },
        {
            "_id": "5c50070c10449e45ec4beaa5",
            "blockID": 10,
            "iIndex": 94
        }
    ],
    "password": "password",
    "__v": 0
}

Map 상세 조회

GET /api/maps/:id

Response

GET /api/maps/5c50070c10449e45ec4beaa4

{
    "bestScore": {
        "user": "uknown",
        "score": 0
    },
    "count": 0,
    "createDate": "2019-01-29T07:28:15.947Z",
    "_id": "5c50070c10449e45ec4beaa4",
    "title": "delete test",
    "owner": "lucas",
    "mapData": [
        {
            "_id": "5c50070c10449e45ec4beaa6",
            "blockID": 10,
            "iIndex": 68
        },
        {
            "_id": "5c50070c10449e45ec4beaa5",
            "blockID": 10,
            "iIndex": 94
        }
    ],
    "password": "password",
    "__v": 0
}

Map 삭제

DELETE /api/maps/:id

Header

password 추가 필요

Response

DELETE /api/maps/5c50070c10449e45ec4beaa4

{}

Map 수정

PUT /api/maps/:id

Header

password 추가 필요

맵정보 수정

Request Body

PUT /api/maps/5c500e8810449e45ec4beaaa

{
    "title": "API TEST2",
    "mapData": [
        {
            "blockID": 10,
            "iIndex": 62
        },
        {
            "blockID": 13,
            "iIndex": 14
        },
        {
            "blockID": 13,
            "iIndex": 92
        },
        {
            "blockID": 3,
            "iIndex": 4
        }
    ]
}

Response

PUT /api/maps/5c500e8810449e45ec4beaaa

{
    "bestScore": {
        "user": "retan",
        "score": 12897734
    },
    "count": 0,
    "createDate": "2019-01-29T07:28:15.947Z",
    "_id": "5c500e8810449e45ec4beaaa",
    "title": "API TEST2",
    "owner": "retan",
    "mapData": [
        {
            "_id": "5c500f4c10449e45ec4beab7",
            "blockID": 10,
            "iIndex": 62
        },
        {
            "_id": "5c500f4c10449e45ec4beab6",
            "blockID": 13,
            "iIndex": 14
        },
        {
            "_id": "5c500f4c10449e45ec4beab5",
            "blockID": 13,
            "iIndex": 92
        },
        {
            "_id": "5c500f4c10449e45ec4beab4",
            "blockID": 3,
            "iIndex": 4
        }
    ],
    "__v": 0
}

BestScore 수정

Request Body

PUT /api/maps/score/5c50070c10449e45ec4beaa4

비밀번호가 필요하지 않습니다

{
    "bestScore": {
        "user": "lucas",
        "score": 12312321
    }
}

Response

PUT /api/maps/score/5c50070c10449e45ec4beaa4

{
    "bestScore": {
        "user": "lucas",
        "score": 12312321
    },
    "count": 0,
    "createDate": "2019-01-29T07:28:15.947Z",
    "_id": "5c50070c10449e45ec4beaa4",
    "title": "delete test",
    "owner": "lucas",
    "mapData": [
        {
            "_id": "5c50070c10449e45ec4beaa6",
            "blockID": 10,
            "iIndex": 68
        },
        {
            "_id": "5c50070c10449e45ec4beaa5",
            "blockID": 10,
            "iIndex": 94
        }
    ],
    "__v": 0
}