search

Jongmo-kim / Personal-NAS

0 stars 0 forks source link

백엔드 설계 원칙을 설정합니다. #29

Closed Jongmo-kim closed 2 years ago

Jongmo-kim commented 2 years ago

백엔드 API를 REST 원칙을 지켜 구현하려고 합니다.

REST 원칙에 관한 내용들을 조사하여 원칙을 적용합니다.

Jongmo-kim commented 2 years ago
  1. Use nouns but no verbs
  2. GET method and query parameters should not alter the state
  3. Use plural nouns
  4. Use sub-resources for relations
  5. Use HTTP headers for serialization formats
  6. Use HATEOAS
  7. Provide filtering, sorting, field selection and paging for collections
  8. Version your API
  9. Handle Errors with HTTP status codes
  10. Allow overriding HTTP method

참고 사이트에서 위와 같은 원칙을 찾았습니다. 다른 사이트에서 다양한 원칙들이 많았지만 너무 많거나 예가 부족하여 적용하기 힘들다고 판단했습니다.

이에따라 파생되는 다양한 이슈들은 따로 만들어 현재 이슈와 링크 시켜 확인할수 있도록 합니다.

Jongmo-kim commented 2 years ago

원칙을 설정했으므로 이슈를 닫습니다.

Jongmo-kim commented 2 years ago

원칙에 대한 자세한 내용은 WIKI에 적어두었습니다.