[Server] 서버 개발 주의사항

1. API 작성 팁

 1) Restful URI 설계

  - 구분자는 하이픈(-)을 사용할 것. ex. sign-up (O), signUp (X), sign_up (X) 

  - Query String에 들어가는 parameter들은 ?와 &를 이용하여 작성해주세요.

    ex) /products?name=&price=

  - 리소스는 복수형을 기본으로 합니다. ex. /user/login (X), /users/login (O)

  - Path Variable은 콜론(:)을 붙여 작성해주세요. 구분자 형식으로는 카멜케이스를 사용합니다.

  - 상태코드는 1000 단위로 나누어 표현합니다.

    1. 1000 : 성공

    2. 2XXX : Request 오류 / Validation

    3. 3XXX : Response 오류 / Validation

    4. 4000 : DB connection, Transaction 등 DB 관련된 모든 오류

 

2. dev/prod

 - 서버 구축의 경우 dev/prod를 나눠서 서버 2개를 운영합니다.

   개인 프로젝트의 경우 나 혼자만 사용하면 되지만,

   실제 외주 프로젝트의 경우 클라이언트 개발자와 외부 사용자들이

   사용하는 서비스이기 때문에 개발 서버와 실서버를 만드는 것이 필수입니다.

   ※ 개발서버는 개인 또는 회사내에 있고, 실서버는 물어보고 그대로 진행

 

 2-1. 역할

  1) 개발 서버 : 클라이언트 개발자가 안정적으로 작업할 수 있는 서버

  2) 실서버 : 실제 사용자들이 안정적으로 서비스를 이용할 수 있는 서버

 

 2-2. 주체별 적용 환경

  1) 서버 개발자 : local

  2) 클라이언트 개발자 : 개발 서버 (dev)

  3) 서비스 사용자 : 실서버 (prod)

 

로컬에서 (자신의 노트북)에서 테스트를 먼저 하신 후, dev에 반영을 해서 테스트를 진행하시면 됩니다.

따라서 로컬에도 개발환경을 구축해주시면 되고, 테스트 url은 localhost로 진행하시면 됩니다!

클라이언트 개발자분에게는 dev 주소를 알려드리면 됩니다!