API 설계를 위한 팁

API 설계는 거창한 게 아니라 쉽게 말하자면 URI(URL)과 method로 이루어져 있는 것을 말합니다.

그렇다면 어떻게 API설계를 하면 될까요?

 

✨ localhost:8080/users/:id에 접속을 하면 id를 map에서 객체를 찾아 해당 객체의 정보를 넘김

URI : localhost:8080/users/:id

method : GET

    - req : params.id(유저의 번호로 map에 저장된 key값을 전달하는데 사용)

    - res : map에서 id로 객체를 조회해서 정보를 전달

 

✨ localhost:8080/users에 접속하여 data를 입력한뒤 서버에 전송을 하면 유저 등록

URI : localhost:8080/users

method : POST

    - req : req.body로 유저의 정보를 전달

    - res : user의 name님 등록이 완료되었습니다. 전달

 

 

이렇게 URI와 method 를 작성하고 구체적으로 req로 뭘 받을 건지, res로 뭘 전달할 건지를 작성해 놓는 것이 중요합니다.