- API
- 웹 API, REST
- REST API
- 목서버, POSTMAN
- PostMan 목업서버 만들기
00. 포스트맨으로 목업서버를 만들려했지만, 몇 번이나 헤맸고 어려워서 남기는 기록
1. API
API는 응용 프로그램(애플리케이션)에서 운영 체제나 프로그래밍 언어가 제공하는 기능을 제어할 수 있게 만든 인터페이스를 뜻합니다.
주로 파일 제어, 창 제어, 화상 처리, 문자 제어 등을 위한 인터페이스를 제공합니다.
즉, API는 리모컨과 점원처럼 애플리케이션과 운영체제 그리고 애플리케이션과 프로그래밍 언어가 제공하는 기능 사이의 '상호 작용'을 도와줍니다.
2-1. 웹 API
웹은 기본적으로 요청(request)과 응답(response)으로 작동합니다.
웹 API는 웹 애플리케이션 개발을 할때 클라이언트와 서버, 애플리케이션과 애플리케이션등 서로 요청과 응답을 주고 받기 위해서 정의한 API입니다.
2-2. REST란
- HTTP URI(Uniform Resource Identifier)를 통해 자원(Resource)을 명시하고,
- HTTP Method(POST, GET, PUT, DELETE, PATCH 등)를 통해
- 해당 자원(URI)에 대한 CRUD Operation을 적용하는 것을 의미합니다.
Create : 데이터 생성(POST)
Read : 데이터 조회(GET)
Update : 데이터 수정(PUT, PATCH)
Delete : 데이터 삭제(DELETE)3.REST API
REST API(REpresentational State Transfer)는 웹상에서 사용되는 여러 리소스를 HTTP URI로 표현하고, 해당 리소스에 대한 행위를 HTTP Method로 정의하는 방식을 말합니다.
3-1 REST API의 설계 가이드
- 리소스에 대한 행위는 HTTP Method(POST, GET, PUT, DELETE)로 표현해야 합니다.
- /(슬래시)는 계층 관계를 나타낼때 사용합니다.
- URI 마지막 문자에 /(슬래시)를 사용하지 않습니다.
- URI는 동사보다는 명사를, 대문자보다는 소문자를 사용하여야 합니다.
- 행위를 포함하지 않습니다.
- 언더바 대신 하이폰을 사용합니다.
- URI에 파일의 확장자(예를들어 .json , .JPGE)를 포함시키지 않습니다.
4. 목서버, POSTMAN
4-1. 목서버(Mock Server)란
- 실제 서버처럼 요청을 받고 응답을 주는 가짜(Mock) 서버를 의미합니다
4-2. Postman란 - API 개발을 보다 빠르고 쉽게 구현 할 수 있도록 도와주며, 개발된 API를 테스트하여 문서화 또는 공유 할 수 있도록 도와 주는 툴입니다. Postman은 모든 API 개발자를 위해서 다양한 기능을 제공합니다.
5. POSTMAN으로 목서버 만들기: 가장 쉽게 mock 서버 만드는 법
5-1. 컬랙션 생성
5-2. 컬렉션 우클릭, 목 컬렉션 클릭
5-3. 목서버 데이터 입력
5-3. 목서버 제작 완료
=> Postman 은 요청을 받을 수 있는 URL을 할당해줍니다.
5-4. request, return 데이터 세팅
- request 추가
- example 추가
- 데이터 샘플 입력
- 사용해보기
6. POSTMAN으로 목서버 만들기2 : 서버 세부적으로 만들기
6-1. Mock server 생성하기
6-2. 관련 내용 적어주고 넥스트넥스트
=> 서버 발급 완료, collection 자동 발급
6-3. {(url)}을 위해, 환경 변수 설정하기
6-4. mock api 반환 형태 설정
=> Response를 줄지 구성해야 하기 때문에 우측 상단에 있는 add examples 누르기
6-5. 샘플 데이터 입력
6-6. 샘플 관련 설명 작성
6-7. API 테스트 해보기
7. POSTMAN으로 목서버 만들기3 :mocking collection 세부적으로 작성
7-1. Mocking할 API들의 Request를 Collection에 만들기
7-2. method를 정하고 hostname을 {{url}}입력 후 경로 쓰기
7-3. add example
7-4. method, hostname은 Request와 동일하게 하고 Header, Params, Body 등을 입력한 후 고정적으로 리턴할 Response를 입력
7-5. 목업 서버 만들기
8. 주의점
- 횟수 제한이 있다.(분당 60회)
- Example의 Request가 같은 것들이 있다면 제일 최근에 추가한 Example 결과로만 된다.(Header, Params, Body에 따라 결과값을 다르게 줄 수 있음)
- Header, Params, Body가 필요없는 경우에는 성공 시의 경우만 Mocking이 가능할 것 같다.
참고
https://velog.io/@taeha7b/api-restapi-restfulapi
https://khj93.tistory.com/entry/%EB%84%A4%ED%8A%B8%EC%9B%8C%ED%81%AC-REST-API%EB%9E%80-REST-RESTful%EC%9D%B4%EB%9E%80
https://way-be-developer.tistory.com/239
https://brownbears.tistory.com/448
https://antdevhistory.tistory.com/3
