최종주차 : API 문서

프론트 - 백 원활한 협업을 위한

api 문서를 잘 자 ^^^^^^^

API를 사용하는 개발자에게 필요한 정보를 제공하는 문서입니다.
API(Application Programming Interface)

Request Headers (요청 헤더)
Request Headers는 API 요청에 대한 추가 정보를 담고 있는 메타데이터입니다. 서버는 이 정보를 통해 요청을 처리하는 데 필요한 다양한 설정과 정보를 알 수 있습니다.

주요 헤더의 예시와 설명:
Content-Type:

요청 본문의 데이터 형식을 나타냅니다.
예: application/json (JSON 형식 데이터), application/x-www-form-urlencoded (URL 인코딩된 형식), multipart/form-data (파일 업로드 등).
Authorization:

인증 정보를 포함합니다. 보통 API 키나 JWT(Json Web Token)를 사용하여 사용자를 인증합니다.
예: Bearer your_token_here
Accept:

클라이언트가 서버로부터 받고 싶은 데이터 형식을 명시합니다.
예: application/json (JSON 형식 데이터 요청)
User-Agent:

요청을 보내는 클라이언트의 정보를 담고 있습니다. 주로 브라우저나 앱의 정보가 포함됩니다.

API Info

• 설명

Request

Request Headers

권한이나 토큰에관한 것

Request Body

Response