[미소 클론코딩 프로젝트] 2-7. 이용자 서비스 API 설계 - 광고용 서비스

2023.08.11 - [초기 과업/BackEnd] - [미소 클론코딩 프로젝트] 2-6. 이용자 서비스 API 설계 - 계약서 서비스

[미소 클론코딩 프로젝트] 2-6. 이용자 서비스 API 설계 - 계약서 서비스

 

안녕하세요. 기깔나는 사람들에서 백엔드를 맡고있는 황시아입니다.

저번 시간까지 계약서 서비스 API 설계를 해 보았습니다.

이번 시간에는 광고용 서비스 API 설계를 해 보겠습니다.

 

---

광고용 서비스 API

업체 관리자가 홍보를 위한 페이지에 사진 등을 꾸며 올리게 되면 해당 내용을 확인할 수 있는 서비스입니다.

---

조회

Request

API 호출 방식

요청 URL	메서드
/api/advertisements/{id}	GET

 

Request Header

Request Header에 대한 상세는 다음과 같습니다.

파라미터	타입	필수 여부	설명
Content-Type	String	필수	application/json이어야 함

 

Request Syntax

curl -X GET http://{BASE_URL}/api/advertisements/{id} \
    -H "Content-Type: application/json;charset=utf-8" \

 

 

Response

Response Elements

Response Elements에 대한 상세는 다음과 같습니다.

필드	상위 필드	타입	필수 여부	설명
statusCode		Integer	필수	API 공통 가이드 - 공통 Response 참조
message		String	필수	API 공통 가이드 - 공통 Response 참조
data		Object	필수	계약서 정보
vendorName	data	String	필수	업체명
vendorAddress	data	String	필수	업체주소
vendorContact	data	String	필수	업체 연락처
title	data	String	필수	광고 제목
content	data	String	필수	광고 내용
createdAt	data	Timestamp	필수	작성일

 

Response Syntax

{
    "statusCode": 200,
    "message": "성공",
    "data": {
        "vendorName": "업체명",
        "vendorAddress": "업체 주소",
        "vendorContact": "업체 연락처",
        "title": "광고 제목",
        "content": "광고 내용",
        "createdAt": "작성일"
    }
}

 

---

생성

Request

API 호출 방식

요청 URL	메서드
/api/advertisements	POST

 

Request Header

Request Header에 대한 상세는 다음과 같습니다.

파라미터	타입	필수 여부	설명
Authorization	String	필수	Bearer {JWT_TOKEN} - {JWT_TOKEN} : 로그인 JWT 토큰
Content-Type	String	필수	application/json이어야 함

 

Request Elements

Request Elements에 대한 상세는 다음과 같습니다

파라미터	타입	필수 여부	설명
title	String	필수	제목
content	String	필수	내용

 

Request Syntax

curl -X POST http://{BASE_URL}/api/advertisements \
    -H "Content-Type: application/json;charset=utf-8" \
    -H "Authorization: Bearer {JWT_TOKEN}"
        -d \
        '{ \
                "title": "제목", \
                "content": "내용" \
        }'

 

 

Response

Response Elements

Response Elements에 대한 상세는 다음과 같습니다

필드	상위 필드	타입	필수 여부	설명
statusCode		Integer	필수	API 공통 가이드 - 공통 Response 참조
message		String	필수	API 공통 가이드 - 공통 Response 참조
data		Object	필수	광고글 정보
id	data	String	필수	광고글 일련번호

 

Response Syntax

{
    "statusCode": 200,
    "message": "성공",
    "data": {
        "id": "일련번호"
    }
}

---

수정

Request

API 호출 방식

요청 URL	메서드
/api/advertisements/{id}	PUT

 

Request Header

Request Header에 대한 상세는 다음과 같습니다.

파라미터	타입	필수 여부	설명
Authorization	String	필수	Bearer {JWT_TOKEN} - {JWT_TOKEN} : 로그인 JWT 토큰
Content-Type	String	필수	application/json이어야 함

 

Request Elements

Request Elements에 대한 상세는 다음과 같습니다

파라미터	타입	필수 여부	설명
title	String	필수	제목
content	String	필수	내용

 

Request Syntax

curl -X PUT http://{BASE_URL}/api/advertisements/{id} \
    -H "Content-Type: application/json;charset=utf-8" \
    -H "Authorization: Bearer {JWT_TOKEN}"
        -d \
        '{ \
                "title": "제목", \
                "content": "내용" \
        }'

 

 

Response

Response Elements

Response Elements에 대한 상세는 다음과 같습니다

필드	상위 필드	타입	필수 여부	설명
statusCode		Integer	필수	API 공통 가이드 - 공통 Response 참조
message		String	필수	API 공통 가이드 - 공통 Response 참조
data		Object	필수	광고글 정보
id	data	String	필수	광고글 일련번호

 

Response Syntax

{
    "statusCode": 200,
    "message": "성공",
    "data": {
        "id": "일련번호"
    }
}

---

삭제

Request

API 호출 방식

요청 URL	메서드
/api/advertisements/{id}	DELETE

 

Request Header

Request Header에 대한 상세는 다음과 같습니다.

파라미터	타입	필수 여부	설명
Authorization	String	필수	Bearer {JWT_TOKEN} - {JWT_TOKEN} : 로그인 JWT 토큰
Content-Type	String	필수	application/json이어야 함

 

Request Elements

없음

 

Request Syntax

curl -X DELETE http://{BASE_URL}/api/advertisements/{id} \
    -H "Content-Type: application/json;charset=utf-8" \
    -H "Authorization: Bearer {JWT_TOKEN}"

 

 

Response

Response Elements

Response Elements에 대한 상세는 다음과 같습니다

필드	상위 필드	타입	필수 여부	설명
statusCode		Integer	필수	API 공통 가이드 - 공통 Response 참조
message		String	필수	API 공통 가이드 - 공통 Response 참조

 

Response Syntax

{
    "statusCode": 200,
    "message": "성공"
}