Postmen API문서와 Axios문법

lyju777·2022년 5월 21일
0
post-thumbnail

🚀Postmen이란?

  • API개발을 보다 쉽고 빠르게 구현할 수 있도록 도와줄 수 있는 플랫폼으로 개발된 API를 문서화시켜 팀원과의 공유를 통해 테스트를 진행할 수가 있다.

  • 백엔드에서 작업한 API를 Postmen으로 확인하여 데이터 통신간에 더 원활한 작업이 가능


Postmen문서

  • Parameter
    -데이터 파라미터값 확인
  • Type
    -데이터 타입 확인
  • Description
    -파라미터값의 정보(내용설명)
  • Mandatory
    -필수 파라미터값의 여부(O로 되어있다면 axios통신 시 반드시 넘겨줘야 하는 값)
  • Request
    -서버에 전달할 파라미터값
  • Response
    -서버에서 통신에 응답하여 클라이언트에 보내주는 값

🗃️Axios란?

  • 브라우저, Node.js를 위한 Promise API를 활용하는 HTTP 비동기 통신 라이브러리

Axios 기본문법

axios({
url: 'https://test/api/postmen', // 통신할 웹문서
headers: {'X-Requested-With': 'XMLHttpRequest'} // 요청 헤더 설정
method: 'post', // 통신할 방식
data: { // 인자로 보낼 데이터
name: 'jack'
age: '23'
}
});

Axios request 파라미터 옵션

  • method : 요청방식. (get이 Default)
  • url: 서버 주소
  • headers : 요청 헤더
  • data : 요청 방식이 'PUT', 'POST', 'PATCH' 해당하는 경우 body에 보내는 데이터
  • params : URL 파라미터 ( ?key=value 로 요청하는 url get방식을 객체로 표현한 것)
profile

0개의 댓글