Rule

Docs

<aside> 💡 [객체 표현]

{
  "member": {
    "name": "줍줍"
  }
}

→ member.name

[배열 표현]

{
  "members": [
    {
      "name": "줍줍"
			"age" : 20
    },
		{
      "name": "줍줍"
			"age" : 20
    },
  ]
}

→ members[].name

</aside>

API

API Response 형식

**성공 시**

**data 있음**
{
	"status" : 200,
	"results" : [
		{
			"title" : "1234"
		}
	]
}

**data 없음**
{
	"status" : 204,
	"results" : null
}

**실패 시**
{
    "status": 403,
		"results" {
				"error_code": "ERR_[DOMAIN]_[NUMBER]",
			  "message": "MEMBER NOT FOUND"
		}
}
// DOMAIN : 서비스 기능 기준

Pagination 반환 형식

{
    "content": [
        {
            "id": 1,
            "name": "수도세",
            "description": "수도세",
            "amount": 9000,
            "category": "청구서",
            "date": "2022-03-06",
            "createdAt": "2022-03-10T13:22:09",
            "updatedAt": "2022-03-10T13:22:09"
        },
        {
            "id": 2,
            "name": "전기세",
            "description": "전기세",
            "amount": 32000,
            "category": "청구서",
            "date": "2022-03-06",
            "createdAt": "2022-03-10T13:22:09",
            "updatedAt": "2022-03-10T13:22:09"
        }
    ],
    "pageable": {
        "sort": {
            "empty": true,
            "sorted": false,
            "unsorted": true
        },
        "offset": 0,
        "pageSize": 2,
        "pageNumber": 0,
        "paged": true,
        "unpaged": false
    },
    "last": false,
    "totalPages": 3,
    "totalElements": 5,
    "size": 2,
    "number": 0,
    "sort": {
        "empty": true,
        "sorted": false,
        "unsorted": true
    },
    "first": true,
    "numberOfElements": 2,
    "empty": false
}

Informations

<aside> 📎 HTTP 메서드의 안전성과 멱등성은 어떻게 다를까?

HTTP 메서드의 주요 속성에는 멱등성 외에도 안전성이 있다. 안전성이 보장된 메서드는 리소스를 변경하지 않는다. GET, HEAD, OPTIONS는 안전한 메서드이다.

안전성이 보장된 메서드는 멱등성도 보장하지만, 멱등성을 지닌 메서드가 항상 안정성을 보장하지는 않는다. 예를 들어 PUT과 DELETE는 멱등한 메서드지만, 리소스에 변화를 일으키기 때문에 안전한 메서드는 아니다.

</aside>

RESTful API를 위한 6가지 원칙과 네이밍