Ho
ho4607
Share
Sign In
api rule
1.
1개의 API는 하나의 기능만 한다.
2.
해당 기능을 완수하지 못하고 방해되는 것은 에러로 처리한다.
쿼리로 필터링 하여 결과가 없는 것은 200에 빈배열 or 빈객체
id로 튜플의 어트리뷰트(속성) 값을 찾을 때는 404 에러를 반환한다.
예시
get device information API
bbbb/aaaa/device/? id = 12312 → 200
bbbb/aaaa/device/12312 →404
없는 device ID에 대한 정보를 요청하면 404 에러를 반환한다.
device
check deviceID API
aaaa/bbbb/device/123/
aaaa/bbbb/device/source/
deviceID가 있는지 체크하는 API에서는 없는 device ID이더라도 check의 의미에 부합하기 때문에 200 정상 응답을 반환한다.
sign up API
회원가입 API에서 이미 가입한 유저가 요청한 경우 회원가입이라는 기능을 수행할 수 없으므로 409 에러를 반환한다.
get day plate API
특정 기간의 유저가 기록한 식단 정보 반환하는 API
해당 기간에 기록한 식단이 없어서 반환할 데이터가 없더라도 특정 기간 동안 유저가 기록한 식단 정보를 반환한다는 기능을 수행했기 때문에 200 정상 응답을 반환한다.
get one plate information API
plate/${}
plateId로 plate의 정보를 반환하는 API
존재하지 않는 plateId로 요청을 보냈다면 해당 plate의 정보를 가져오지 못 했기 때문에 plate의 정보를 반환한다는 API의 기능을 수행하지 못 했기 때문에 404 에러를 반환한다.
3.
1개의 API는 하나의 기능만 한다.
4.
해당 기능을 완수하지 못하고 방해되는 것은 에러로 처리한다.
쿼리로 필터링 하여 결과가 없는 것은 200에 빈배열 or 빈객체
id로 튜플의 어트리뷰트(속성) 값을 찾을 때는 404 에러를 반환한다.
예시
get device information API
bbbb/aaaa/device/? id = 12312 → 200
bbbb/aaaa/device/12312 →404
없는 device ID에 대한 정보를 요청하면 404 에러를 반환한다.
device
check deviceID API
aaaa/bbbb/device/123/
aaaa/bbbb/device/source/
deviceID가 있는지 체크하는 API에서는 없는 device ID이더라도 check의 의미에 부합하기 때문에 200 정상 응답을 반환한다.
sign up API
회원가입 API에서 이미 가입한 유저가 요청한 경우 회원가입이라는 기능을 수행할 수 없으므로 409 에러를 반환한다.
get day plate API
특정 기간의 유저가 기록한 식단 정보 반환하는 API
해당 기간에 기록한 식단이 없어서 반환할 데이터가 없더라도 특정 기간 동안 유저가 기록한 식단 정보를 반환한다는 기능을 수행했기 때문에 200 정상 응답을 반환한다.
get one plate information API
plate/${}
plateId로 plate의 정보를 반환하는 API
존재하지 않는 plateId로 요청을 보냈다면 해당 plate의 정보를 가져오지 못 했기 때문에 plate의 정보를 반환한다는 API의 기능을 수행하지 못 했기 때문에 404 에러를 반환한다.
5.
1개의 API는 하나의 기능만 한다.
6.
해당 기능을 완수하지 못하고 방해되는 것은 에러로 처리한다.
쿼리로 필터링 하여 결과가 없는 것은 200에 빈배열 or 빈객체
id로 튜플의 어트리뷰트(속성) 값을 찾을 때는 404 에러를 반환한다.
예시
get device information API
bbbb/aaaa/device/? id = 12312 → 200
bbbb/aaaa/device/12312 →404
없는 device ID에 대한 정보를 요청하면 404 에러를 반환한다.
device
check deviceID API
aaaa/bbbb/device/123/
aaaa/bbbb/device/source/
deviceID가 있는지 체크하는 API에서는 없는 device ID이더라도 check의 의미에 부합하기 때문에 200 정상 응답을 반환한다.
sign up API
회원가입 API에서 이미 가입한 유저가 요청한 경우 회원가입이라는 기능을 수행할 수 없으므로 409 에러를 반환한다.
get day plate API
특정 기간의 유저가 기록한 식단 정보 반환하는 API
해당 기간에 기록한 식단이 없어서 반환할 데이터가 없더라도 특정 기간 동안 유저가 기록한 식단 정보를 반환한다는 기능을 수행했기 때문에 200 정상 응답을 반환한다.
get one plate information API
plate/${}
plateId로 plate의 정보를 반환하는 API
존재하지 않는 plateId로 요청을 보냈다면 해당 plate의 정보를 가져오지 못 했기 때문에 plate의 정보를 반환한다는 API의 기능을 수행하지 못 했기 때문에 404 에러를 반환한다.
7.
1개의 API는 하나의 기능만 한다.
8.
해당 기능을 완수하지 못하고 방해되는 것은 에러로 처리한다.
쿼리로 필터링 하여 결과가 없는 것은 200에 빈배열 or 빈객체
id로 튜플의 어트리뷰트(속성) 값을 찾을 때는 404 에러를 반환한다.
예시
get device information API
bbbb/aaaa/device/? id = 12312 → 200
bbbb/aaaa/device/12312 →404
없는 device ID에 대한 정보를 요청하면 404 에러를 반환한다.
device
check deviceID API
aaaa/bbbb/device/123/
aaaa/bbbb/device/source/
deviceID가 있는지 체크하는 API에서는 없는 device ID이더라도 check의 의미에 부합하기 때문에 200 정상 응답을 반환한다.
sign up API
회원가입 API에서 이미 가입한 유저가 요청한 경우 회원가입이라는 기능을 수행할 수 없으므로 409 에러를 반환한다.
get day plate API
특정 기간의 유저가 기록한 식단 정보 반환하는 API
해당 기간에 기록한 식단이 없어서 반환할 데이터가 없더라도 특정 기간 동안 유저가 기록한 식단 정보를 반환한다는 기능을 수행했기 때문에 200 정상 응답을 반환한다.
get one plate information API
plate/${}
plateId로 plate의 정보를 반환하는 API
존재하지 않는 plateId로 요청을 보냈다면 해당 plate의 정보를 가져오지 못 했기 때문에 plate의 정보를 반환한다는 API의 기능을 수행하지 못 했기 때문에 404 에러를 반환한다.
9.
1개의 API는 하나의 기능만 한다.
10.
해당 기능을 완수하지 못하고 방해되는 것은 에러로 처리한다.
쿼리로 필터링 하여 결과가 없는 것은 200에 빈배열 or 빈객체
id로 튜플의 어트리뷰트(속성) 값을 찾을 때는 404 에러를 반환한다.
예시
get device information API
bbbb/aaaa/device/? id = 12312 → 200
bbbb/aaaa/device/12312 →404
없는 device ID에 대한 정보를 요청하면 404 에러를 반환한다.
device
check deviceID API
aaaa/bbbb/device/123/
aaaa/bbbb/device/source/
deviceID가 있는지 체크하는 API에서는 없는 device ID이더라도 check의 의미에 부합하기 때문에 200 정상 응답을 반환한다.
sign up API
회원가입 API에서 이미 가입한 유저가 요청한 경우 회원가입이라는 기능을 수행할 수 없으므로 409 에러를 반환한다.
get day plate API
특정 기간의 유저가 기록한 식단 정보 반환하는 API
해당 기간에 기록한 식단이 없어서 반환할 데이터가 없더라도 특정 기간 동안 유저가 기록한 식단 정보를 반환한다는 기능을 수행했기 때문에 200 정상 응답을 반환한다.
get one plate information API
plate/${}
plateId로 plate의 정보를 반환하는 API
존재하지 않는 plateId로 요청을 보냈다면 해당 plate의 정보를 가져오지 못 했기 때문에 plate의 정보를 반환한다는 API의 기능을 수행하지 못 했기 때문에 404 에러를 반환한다.
11.
1개의 API는 하나의 기능만 한다.
12.
해당 기능을 완수하지 못하고 방해되는 것은 에러로 처리한다.
쿼리로 필터링 하여 결과가 없는 것은 200에 빈배열 or 빈객체
id로 튜플의 어트리뷰트(속성) 값을 찾을 때는 404 에러를 반환한다.
예시
get device information API
bbbb/aaaa/device/? id = 12312 → 200
bbbb/aaaa/device/12312 →404
없는 device ID에 대한 정보를 요청하면 404 에러를 반환한다.
device
check deviceID API
aaaa/bbbb/device/123/
aaaa/bbbb/device/source/
deviceID가 있는지 체크하는 API에서는 없는 device ID이더라도 check의 의미에 부합하기 때문에 200 정상 응답을 반환한다.
sign up API
회원가입 API에서 이미 가입한 유저가 요청한 경우 회원가입이라는 기능을 수행할 수 없으므로 409 에러를 반환한다.
get day plate API
특정 기간의 유저가 기록한 식단 정보 반환하는 API
해당 기간에 기록한 식단이 없어서 반환할 데이터가 없더라도 특정 기간 동안 유저가 기록한 식단 정보를 반환한다는 기능을 수행했기 때문에 200 정상 응답을 반환한다.
get one plate information API
plate/${}
plateId로 plate의 정보를 반환하는 API
존재하지 않는 plateId로 요청을 보냈다면 해당 plate의 정보를 가져오지 못 했기 때문에 plate의 정보를 반환한다는 API의 기능을 수행하지 못 했기 때문에 404 에러를 반환한다.
13.
1개의 API는 하나의 기능만 한다.
14.
해당 기능을 완수하지 못하고 방해되는 것은 에러로 처리한다.
쿼리로 필터링 하여 결과가 없는 것은 200에 빈배열 or 빈객체
id로 튜플의 어트리뷰트(속성) 값을 찾을 때는 404 에러를 반환한다.
예시
get device information API
bbbb/aaaa/device/? id = 12312 → 200
bbbb/aaaa/device/12312 →404
없는 device ID에 대한 정보를 요청하면 404 에러를 반환한다.
device
check deviceID API
aaaa/bbbb/device/123/
aaaa/bbbb/device/source/
deviceID가 있는지 체크하는 API에서는 없는 device ID이더라도 check의 의미에 부합하기 때문에 200 정상 응답을 반환한다.
sign up API
회원가입 API에서 이미 가입한 유저가 요청한 경우 회원가입이라는 기능을 수행할 수 없으므로 409 에러를 반환한다.
get day plate API
특정 기간의 유저가 기록한 식단 정보 반환하는 API
해당 기간에 기록한 식단이 없어서 반환할 데이터가 없더라도 특정 기간 동안 유저가 기록한 식단 정보를 반환한다는 기능을 수행했기 때문에 200 정상 응답을 반환한다.
get one plate information API
plate/${}
plateId로 plate의 정보를 반환하는 API
존재하지 않는 plateId로 요청을 보냈다면 해당 plate의 정보를 가져오지 못 했기 때문에 plate의 정보를 반환한다는 API의 기능을 수행하지 못 했기 때문에 404 에러를 반환한다.
15.
1개의 API는 하나의 기능만 한다.
16.
해당 기능을 완수하지 못하고 방해되는 것은 에러로 처리한다.
쿼리로 필터링 하여 결과가 없는 것은 200에 빈배열 or 빈객체
id로 튜플의 어트리뷰트(속성) 값을 찾을 때는 404 에러를 반환한다.
예시
get device information API
bbbb/aaaa/device/? id = 12312 → 200
bbbb/aaaa/device/12312 →404
없는 device ID에 대한 정보를 요청하면 404 에러를 반환한다.
device
check deviceID API
aaaa/bbbb/device/123/
aaaa/bbbb/device/source/
deviceID가 있는지 체크하는 API에서는 없는 device ID이더라도 check의 의미에 부합하기 때문에 200 정상 응답을 반환한다.
sign up API
회원가입 API에서 이미 가입한 유저가 요청한 경우 회원가입이라는 기능을 수행할 수 없으므로 409 에러를 반환한다.
get day plate API
특정 기간의 유저가 기록한 식단 정보 반환하는 API
해당 기간에 기록한 식단이 없어서 반환할 데이터가 없더라도 특정 기간 동안 유저가 기록한 식단 정보를 반환한다는 기능을 수행했기 때문에 200 정상 응답을 반환한다.
get one plate information API
plate/${}
plateId로 plate의 정보를 반환하는 API
존재하지 않는 plateId로 요청을 보냈다면 해당 plate의 정보를 가져오지 못 했기 때문에 plate의 정보를 반환한다는 API의 기능을 수행하지 못 했기 때문에 404 에러를 반환한다.
17.
1개의 API는 하나의 기능만 한다.
18.
해당 기능을 완수하지 못하고 방해되는 것은 에러로 처리한다.
쿼리로 필터링 하여 결과가 없는 것은 200에 빈배열 or 빈객체
id로 튜플의 어트리뷰트(속성) 값을 찾을 때는 404 에러를 반환한다.
예시
get device information API
bbbb/aaaa/device/? id = 12312 → 200
bbbb/aaaa/device/12312 →404
없는 device ID에 대한 정보를 요청하면 404 에러를 반환한다.
device
check deviceID API
aaaa/bbbb/device/123/
aaaa/bbbb/device/source/
deviceID가 있는지 체크하는 API에서는 없는 device ID이더라도 check의 의미에 부합하기 때문에 200 정상 응답을 반환한다.
sign up API
회원가입 API에서 이미 가입한 유저가 요청한 경우 회원가입이라는 기능을 수행할 수 없으므로 409 에러를 반환한다.
get day plate API
특정 기간의 유저가 기록한 식단 정보 반환하는 API
해당 기간에 기록한 식단이 없어서 반환할 데이터가 없더라도 특정 기간 동안 유저가 기록한 식단 정보를 반환한다는 기능을 수행했기 때문에 200 정상 응답을 반환한다.
get one plate information API
plate/${}
plateId로 plate의 정보를 반환하는 API
존재하지 않는 plateId로 요청을 보냈다면 해당 plate의 정보를 가져오지 못 했기 때문에 plate의 정보를 반환한다는 API의 기능을 수행하지 못 했기 때문에 404 에러를 반환한다.
19.
1개의 API는 하나의 기능만 한다.
20.
해당 기능을 완수하지 못하고 방해되는 것은 에러로 처리한다.
쿼리로 필터링 하여 결과가 없는 것은 200에 빈배열 or 빈객체
id로 튜플의 어트리뷰트(속성) 값을 찾을 때는 404 에러를 반환한다.
예시
get device information API
bbbb/aaaa/device/? id = 12312 → 200
bbbb/aaaa/device/12312 →404
없는 device ID에 대한 정보를 요청하면 404 에러를 반환한다.
device
check deviceID API
aaaa/bbbb/device/123/
aaaa/bbbb/device/source/
deviceID가 있는지 체크하는 API에서는 없는 device ID이더라도 check의 의미에 부합하기 때문에 200 정상 응답을 반환한다.
sign up API
회원가입 API에서 이미 가입한 유저가 요청한 경우 회원가입이라는 기능을 수행할 수 없으므로 409 에러를 반환한다.
get day plate API
특정 기간의 유저가 기록한 식단 정보 반환하는 API
해당 기간에 기록한 식단이 없어서 반환할 데이터가 없더라도 특정 기간 동안 유저가 기록한 식단 정보를 반환한다는 기능을 수행했기 때문에 200 정상 응답을 반환한다.
get one plate information API
plate/${}
plateId로 plate의 정보를 반환하는 API
존재하지 않는 plateId로 요청을 보냈다면 해당 plate의 정보를 가져오지 못 했기 때문에 plate의 정보를 반환한다는 API의 기능을 수행하지 못 했기 때문에 404 에러를 반환한다.
21.
1개의 API는 하나의 기능만 한다.
22.
해당 기능을 완수하지 못하고 방해되는 것은 에러로 처리한다.
쿼리로 필터링 하여 결과가 없는 것은 200에 빈배열 or 빈객체
id로 튜플의 어트리뷰트(속성) 값을 찾을 때는 404 에러를 반환한다.
예시
get device information API
bbbb/aaaa/device/? id = 12312 → 200
bbbb/aaaa/device/12312 →404
없는 device ID에 대한 정보를 요청하면 404 에러를 반환한다.
device
check deviceID API
aaaa/bbbb/device/123/
aaaa/bbbb/device/source/
deviceID가 있는지 체크하는 API에서는 없는 device ID이더라도 check의 의미에 부합하기 때문에 200 정상 응답을 반환한다.
sign up API
회원가입 API에서 이미 가입한 유저가 요청한 경우 회원가입이라는 기능을 수행할 수 없으므로 409 에러를 반환한다.
get day plate API
특정 기간의 유저가 기록한 식단 정보 반환하는 API
해당 기간에 기록한 식단이 없어서 반환할 데이터가 없더라도 특정 기간 동안 유저가 기록한 식단 정보를 반환한다는 기능을 수행했기 때문에 200 정상 응답을 반환한다.
get one plate information API
plate/${}
plateId로 plate의 정보를 반환하는 API
존재하지 않는 plateId로 요청을 보냈다면 해당 plate의 정보를 가져오지 못 했기 때문에 plate의 정보를 반환한다는 API의 기능을 수행하지 못 했기 때문에 404 에러를 반환한다.
23.
1개의 API는 하나의 기능만 한다.
24.
해당 기능을 완수하지 못하고 방해되는 것은 에러로 처리한다.
쿼리로 필터링 하여 결과가 없는 것은 200에 빈배열 or 빈객체
id로 튜플의 어트리뷰트(속성) 값을 찾을 때는 404 에러를 반환한다.
예시
get device information API
bbbb/aaaa/device/? id = 12312 → 200
bbbb/aaaa/device/12312 →404
없는 device ID에 대한 정보를 요청하면 404 에러를 반환한다.
device
check deviceID API
aaaa/bbbb/device/123/
aaaa/bbbb/device/source/
deviceID가 있는지 체크하는 API에서는 없는 device ID이더라도 check의 의미에 부합하기 때문에 200 정상 응답을 반환한다.
sign up API
회원가입 API에서 이미 가입한 유저가 요청한 경우 회원가입이라는 기능을 수행할 수 없으므로 409 에러를 반환한다.
get day plate API
특정 기간의 유저가 기록한 식단 정보 반환하는 API
해당 기간에 기록한 식단이 없어서 반환할 데이터가 없더라도 특정 기간 동안 유저가 기록한 식단 정보를 반환한다는 기능을 수행했기 때문에 200 정상 응답을 반환한다.
get one plate information API
plate/${}
plateId로 plate의 정보를 반환하는 API
존재하지 않는 plateId로 요청을 보냈다면 해당 plate의 정보를 가져오지 못 했기 때문에 plate의 정보를 반환한다는 API의 기능을 수행하지 못 했기 때문에 404 에러를 반환한다.
25.
1개의 API는 하나의 기능만 한다.
26.
해당 기능을 완수하지 못하고 방해되는 것은 에러로 처리한다.
쿼리로 필터링 하여 결과가 없는 것은 200에 빈배열 or 빈객체
id로 튜플의 어트리뷰트(속성) 값을 찾을 때는 404 에러를 반환한다.
예시
get device information API
bbbb/aaaa/device/? id = 12312 → 200
bbbb/aaaa/device/12312 →404
없는 device ID에 대한 정보를 요청하면 404 에러를 반환한다.
device
check deviceID API
aaaa/bbbb/device/123/
Made with SlashPage