TIL : 210625_금_(REST API)

beablessing·2021년 6월 26일
0

TIL

목록 보기
21/33
post-thumbnail

오늘 배운것

  • REST API
  • POSTMAN 사용법

REST API

HTTP가 가진 능력을 가장 잘 이용하기 위한 모범사례라고 볼 수 있다.
API설계는 서버개발자에게 달려있는데, REST API는 API의 대표적인 아키텍쳐.

  • 웹에서 사용되는 모든 리소스를 http uri로 표현하고, 메소드를 사용해서 요청과 응답을 정읜한다.
  • 엔드포인트
    루트URL이라고도 말하고, 서버가 요청을 수락하는 시작점이 된다.
    뒤에 /를 붙이고 path 를 입력하는데 -> 서버와 통신할 수 있는 키 역할을 한다.
    https://api.github.con/beablessing 에서 beablessing이 path.

REST API _ GET 메세지조회

  • 요청하기 request
    GET / {key} / messages key가 작성한 모든 메세지 조회
    추가적인 파라미터를 붙일 수 있는데
    /{Key} / messages ?roomname=로비
    이런경우 roomname이 로비인 것만 조회할 수 있다.
  • 응답하기
    json의 형태로 응답을 받게 됨.
[
  {
 	"id":1,
    "username":"김코딩"
  }
]

REST API _ POST 메세지추가

  • 요청하기
    요청본문이 필요함
    POST / {key} / messages 메세지가 24시간 마다 자동 리셋
    요청본문엔 GET으로 가져온 형식의 내용들이 모두 포함되어야 합니다.
    요청형식은 json    mime타입: application/json
  • 응답하기
    json형식으로 받고, id값 부분만을 받아온다.(추가된 id값)
    예를들어 id5번째에 포스트를 하면, id:5를 응답으로 받게 됨.
[
  {
  	"id": 5
  }
]

REST API _ 메세지초기화

  • 요청하기
    POST /{githubID}/clear
    요청본분은 필요하지 않음.
  • 응답하기
{
	"message":"message initialized!"
}


URI 정보의 자원을 표현합니다. / 자원에 대한 상태 정의는 http메소드로 표현하게 된다.

postman 사용법

왜인지 처음 포스트맨을 가입했을 때는 블라우저에서는 제대로 get요청이 먹히지 않아서
postman앱을 다운받아 사용하였다. (우분투 사용자) 그런데 이번에 다시 사용해보니 브라우저 역시 제대로 돌아갔다. 사용법에 문제가 있었던건가 싶기도 하다.

http api 테스트를 할 수 있는 방법에는 여러가지가 있는데, 그 중 가장 쉬운 GUI_postman을 사용해 보았다.

GET

  • 맨 앞 셀렉션중 GET을 선택하고, url + 요청path를 입력하면
    응답으로 JSON형식의 데이터를 받아 오게 된다.

POST

포스트의 경우 요청본문이 필수적이기 때문에,
아래 body 체크 -> raw체크 -> json체크 후,
(json형식으로 보낼때는 raw를 선택한다)
요청본문을 json형태로 작성해준다.

응답확인하기

응답부분 우측상단에 status 400bad req등 응답코드가 표시된다.
post가 성공적으로 적용되었다면
응답바디에 json 형식으로 id값을 받고,status 도 잘받아오게 된다. (created)

profile
프론트엔드 개발자

0개의 댓글