기술 산업은 웹이든 모바일이든 소프트웨어 개발에서 많은 도약을 이뤘습니다. 현재의 주요 하이라이트는 소프트웨어 개발에서 애플리케이션 프로그래밍 인터페이스(API)의 효율적인 사용입니다. API가 제공하는 각 기능은 소프트웨어 애플리케이션에 추가적인 이점을 제공합니다. 이는 서로 다른 소프트웨어 시스템이 쉽게 상호작용하고 데이터를 공유할 수 있도록 하여 개발 효율성을 개선합니다. 예를 들어, 파일 업로드는 많은 API가 지원하는 가장 중요한 기능 중 하나로, 사용자가 이미지, 비디오 및 문서와 같은 파일을 업로드하고 공유할 수 있게 해줍니다.
이 기사는 API에서 파일 업로드의 기본 개념을 살펴본 후 Apidog에서의 단계별 가이드를 제공합니다. Apidog는
API에서 파일 업로드의 기본 개념
API에서 파일 업로드가 어떻게 작동하는지 직접 살펴보기에 앞서, 먼저 몇 가지 핵심 개념을 학습해야 합니다.
Content-Type
Content-Type HTTP 헤더는 HTTP 메시지 본문에 전송된 콘텐츠의 유형을 지정합니다. 이 헤더는 수신 서버나 클라이언트에게 반환된 콘텐츠 유형과 이를 처리하는 방법을 알려주기 때문에 HTTP 요청 및 응답의 중요한 부분입니다. 콘텐츠 유형은 텍스트, HTML, JSON 또는 XML과 같은 전송된 데이터의 형식을 지정하고 서버가 콘텐츠를 올바르게 구문 분석할 수 있도록 합니다. application/json, text/plain, application/x-www-form-urlencoded, multipart/form-data는 가장 일반적으로 사용되는 콘텐츠 유형입니다. 우리의 맥락에서는 파일이 요청 본문에 포함될 수 있도록 multipart/form-data로 콘텐츠 타입을 설정합니다.
클라이언트가 multipart/form-data 콘텐츠 유형으로 요청을 제출하면, 요청 본문은 각 데이터 조각을 포함하는 여러 부분으로 나뉩니다. 콘텐츠 유형 헤더의 경계 문자열이 각 부분을 구분하며, 이 문자열은 고유해야 하고 전송된 데이터에 나타나지 않아야 합니다.
요청의 각 부분은 이름과 값 쌍 또는 파일을 포함할 수 있습니다. 예를 들어, 파일 업로드 필드가 있는 HTML 양식은 파일의 이진 데이터를 포함하는 file 부분과 파일 이름을 포함하는 name 부분이 있는 요청을 제출할 수 있습니다. 다른 부분은 양식 필드나 메타데이터와 같은 추가 데이터를 포함할 수 있습니다. 헤더의 형식은 다음과 같습니다:
Content-Type: multipart/form-data;
boundary=----xyz123위에서 논의된 바와 같이 게시된 데이터는 여러 부분으로 나뉘므로 서버는 각 부분의 시작과 끝을 인식해야 합니다. 요청 본문의 각 부분은 두 개의 대시 “--”로 앞서고 있는 경계 문자열로 구분됩니다. 마지막 부분은 두 개의 대시와 경계 문자열로 뒤따르며 두 개의 대시가 추가로 뒤따릅니다. 경계는 일반적으로 여러 개의 대시로 시작하고 영숫자 접미사로 끝납니다(예: ------xyz123).
-- ----xyz123 Content-Disposition: form-data; name="file"; filename="example.png" Content-Type: image/png
<파일의 이진 데이터>
-- ----xyz123
Content-Disposition: form-data; name="field1"
value1 -- ----xyz123--이 예에서 요청 본문은 파일의 이진 데이터를 가진 파일 부분과 값 value1을 가진 이름 부분을 포함합니다. 경계 문자열이 각 부분을 구분하며, 마지막 부분 뒤에 두 개의 대시가 뒤따르고 경계 문자열 뒤에도 두 개의 대시가 추가로 뒤따릅니다.
HTTP 메서드
HTTP 메서드는 서버에 전송되는 메시지로, 수행할 작업의 유형을 지정합니다. 이러한 메서드는 브라우저와 서버 간의 더 포괄적인 통신을 가능하게 합니다. 일부 HTTP 메서드는 아래와 같습니다:
● GET: 서버에서 리소스를 검색합니다.
● POST: 엔터티를 서버에 제출하고 새 리소스를 생성합니다.
● PUT: 서버의 기존 리소스를 업데이트합니다.
● DELETE: 서버에서 리소스를 삭제합니다.
● PATCH: 서버의 기존 리소스를 부분적으로 업데이트합니다.
● HEAD: 본문 없이 리소스의 헤더를 검색합니다.
● OPTIONS: 리소스가 지원하는 HTTP 메서드를 검색합니다.
● TRACE: 대상 리소스로의 경로를 따라 메시지 루프백 테스트가 실행됩니다.
우리의 맥락에서는 파일 업로드 요청을 제출하기 위해 POST HTTP 메서드를 사용해야 합니다. 이는 요청 본문에서 데이터 제출을 지원하는 POST 메서드 때문입니다.
파일 인코딩
이진 파일에서 문자 데이터를 나타내는 데 사용되는 방법을 파일 인코딩이라고 합니다. 이는 파일의 데이터가 다양한 시스템 및 소프트웨어에서 올바르게 저장, 전송 및 해석될 수 있도록 보장합니다. 다양한 파일 인코딩이 있지만, UTF-8 및 ASCII가 포함됩니다.
API에서 파일 업로드 작업을 수행할 때 파일 인코딩이 서버 및 이를 처리하는 다른 시스템과 호환되는지 확인하는 것이 중요합니다. 일반적으로 UTF-8은 많은 시스템에서 널리 지원되므로 기본 파일 인코딩으로 사용됩니다.
파일 크기 제한
파일 크기 제한은 서버에 업로드할 수 있는 최대 파일 크기를 나타냅니다. 파일 크기 제한을 조정하면 서비스 거부 공격을 방지하고 대형 파일이 서버의 리소스를 과도하게 부담하지 않도록 할 수 있습니다. 이 제한은 클라이언트와 서버 수준 모두에서 설정할 수 있습니다.
파일 업로드 요청을 만드는 데 사용되는 브라우저나 소프트웨어는 클라이언트 수준에서 파일 크기 제한을 적용할 수 있습니다. 브라우저는 일반적으로 파일 크기 제한이 있으며 이는 브라우저와 운영 체제에 따라 다릅니다. 예를 들어, 일부 브라우저는 파일 업로드를 2GB로 제한하는 반면, 다른 브라우저는 더 큰 업로드를 허용합니다. 반대로, 파일 크기 제한은 웹 서버 구성 또는 응용 프로그램 코드에서 서버 수준에서 설정될 수 있으며, 이는 서버의 사용 가능한 리소스, 일반적으로 업로드되는 파일의 크기 및 원하는 보안 수준에 따라 구성될 수 있습니다.
파일 업로드를 수락하는 API 엔드포인트는 과도하게 큰 파일이 업로드되는 것을 방지하기 위해 파일 크기 제한을 가져야 하며, 서버가 안정적이고 반응성이 유지되도록 해야 합니다.
API를 사용한 요청에서 파일 업로드 방법
Apidog 는 개발자가 API를 생성, 문서화, 디버그, 테스트 및 목업할 수 있도록 돕는 API 문서화 및 테스트 도구입니다. 그 목표는 간단하고 사용하기 쉬운 인터페이스를 제공하여 REST API를 더 쉽게 생성하고 관리하는 것입니다. Apidog는 클라우드 기반 버전이 제공되며, 다양한 프로그래밍 언어 및 API 프레임워크를 지원하여 API에서 파일을 원활하게 업로드할 수 있도록 돕습니다.
이제 API에서 파일 업로드의 기본 사항을 다루었고 Apidog가 무엇인지 이해했으므로, Apidog로 파일 업로드 작업을 수행하는 단계별 지침으로 들어가 보겠습니다.
단계 1: 새 프로젝트 만들기
Apidog 애플리케이션을 열고 새 요청을 만듭니다.
단계 2: 요청 방법 선택
드롭다운 옵션에서 GET, POST, PUT, DELETE, TRACE, HEAD 등을 포함하는 POST 요청 방법을 선택합니다.
이제 파일을 받을 서버의 URL을 입력해야 합니다. Apidog의 도움으로 사용 가능한 로컬 목업 기능을 사용하여 테스트할 수 있으며, 이 예제에서는 자동차의 이미지를 업로드하고자 하므로 URL에 /car를 추가하기만 하면 됩니다.
이것은 제한이 없으며, 파일을 받을 수 있는 서버를 사용할 수 있으며, 이는 Apidog에서 제공하는 테스트 또는 생산 환경의 도움으로도 가능합니다.
단계 3: 요청 본문 콘텐츠 유형 설정
다음으로 요청 본문 콘텐츠 유형을 multipart/form-data로 설정합니다. 이는 클라이언트가 요청 본문에 파일을 포함할 수 있도록 보장합니다. 이는 본문 섹션으로 이동하여 아래와 같이 양식 데이터를 선택하여 수행할 수 있습니다:
단계 4: 요청 본문에 파일 필드 추가
클라이언트가 API에 파일을 업로드할 수 있도록 요청 본문에 파일 필드를 포함합니다. 그렇게 하려면 새 매개변수 추가 상자를 클릭하고 필드 이름을 추가한 후 드롭다운 메뉴에서 파일을 선택합니다.
위 이미지에서 드롭다운에서 파일을 선택하면 파일을 업로드할 수 있음을 알 수 있습니다.
단계 5: 요청 저장 및 테스트
요청을 구성한 후 이를 저장하고 Apidog 테스트 도구로 테스트합니다. 그렇게 하려면 엔드포인트 편집기에서 전송 버튼을 클릭합니다. 그러면 파일 업로드 요청을 엔드포인트에 전송하고 서버가 파일 및 요청 본문에 포함된 추가 데이터를 수신했는지 확인할 수 있습니다. 마지막으로 아래와 같이 최종 출력을 볼 수 있습니다:
또한 Apidog가 제공하는 여러 형식의 코드 출력을 볼 수 있으며, Shell, JavaScript, Java, Swift, Go, PHP, Python, HTTP, C, C#, Ruby 등을 포함하며 이를 아래 이미지에서 확인할 수 있습니다:
축하합니다! Apidog의 도움으로 파일 업로드 요청을 성공적으로 추가했습니다.
결론
파일 업로드 기능은 많은 웹 및 모바일 애플리케이션에 필수적이며, 파일 업로드 API는 점점 더 일반화되고 있습니다. 이 기사에서는 파일 업로드를 수용하는 API를 개발할 때 콘텐츠 유형, HTTP 메서드, 파일 인코딩, 파일 크기 제한 및 보안 조치를 고려하는 것이 중요함을 보여주었습니다.
마지막으로, Apidog의 강력한 API 및 요청 설계 및 테스트 도구의 도움으로 API와 요청에서 파일 업로드를 설정하는 과정이 매우 적은 단계로 쉽게 이루어집니다.
