오늘은 Postman 파일 업로드 테스트 방법을 알아보도록 하겠습니다.
파일 업로드를 테스트하고자 할 때 프론트엔드를 아직 개발하지 못한 경우를 대비하여, Postman 파일 업로드 테스트 방법에 대해서 정리해 보았습니다. 백엔드 API 설계시 큰 도움이 될 것으로 보입니다.
Node.js, 파이썬, php 등 여타 백엔드의 파일 업로드 API가 준비되었을 때, 파일 업로드 테스트시 프론트엔드 프로그램이 아직 개발이 다 안되었다면 테스트가 난감할 때가 있는데요, 이럴 때에는 Postman으로 간단히 테스트를 진행해 볼 수 있습니다.
API 테스트를 위한 포스트맨 설치
만약 포스트맨(Postman)이 없다면 공식 홈페이지를 통해 설치할 수 있습니다.
윈도우 운영체제인 경우 설치 링크 중간에서 다운로드 할 수 있습니다.
API를 테스트 할 때 필수적인 프로그램이니 꼭 설치하시기를 추천합니다.
포스트맨 파일 업로드 테스트 상세 방법
여기서의 백엔드 api는 간단히 입력 받은 파일의 이름을 리턴하는 API로 테스트를 진행했습니다. 예제를 파이썬 fastapi를 사용했으며 간단히 다음과 같이 작성했습니다.
간단한 코드이기 때문에 Node.js나 파이썬 Flask 등 다른 언어 혹은 프레임워크를 사용한다 하더라도 포스트맨 파일 업로드 테스트 방법을 쉽게 이해하실 수 있으실거라 생각됩니다.
@app.post("/api/file")
async def api_file(file:UploadFile=File(...)):
# UploadFile : FastApi에서 제공하는 파일 업로드 클래스
# return : filename을 json 형태로 리턴
return {"filename": file.filename}우선 Postman을 실행한 후, 상단의 + New 버튼을 클릭하고, Request를 선택합니다.
그런 후 파일 업로드는 HTTP 메서드 중 POST를 사용하므로 POST 메서드를 선택해 줍니다.
우리가 만든 백엔드 파일 업로드 API 주소를 입력한 후, Body 탭으로 이동한 후 form-data를 선택합니다.
그러면 다음과 같이 우리의 백엔드 서버 API 로부터 받은 응답 결과를 Body 탭에서 볼 수 있습니다.
Postman 파일 업로드 테스트 방법에 대해서 알아보았습니다. 이 외에도 쥬피터 노트북, 구글의 코랩을 이용하여 파일업로드를 테스트할 수 있는 방법은 추후 포스팅 해보도록 하겠습니다.