Keyword

API Documentation

Endpoints

1. Get Keyword

- 키워드 전체 조회

• EndPoint: /keyword/user/{userId}

• Method: GET

• Request: None

• Response:

  • success: Boolean
  • message: String
  • keywordList (keywordId, keyword)
    • keywordId: UUID (unique)
    • keyword: String

• Response Success Example:

{
    "keywordList": [
        {
            "keywordId": "599ab214-ee6c-45ed-a18b-0b0b9f6a76a7",
            "keyword": "김밍쥐"
        },
        {
            "keywordId": "c7205a9f-400c-4f0b-a485-31681b7a4a5c",
            "keyword": "임임정윤"
        },
        {
            "keywordId": "84e33dec-b2fd-4a22-9069-4e7c2698ad65",
            "keyword": "1234"
        },
        {
            "keywordId": "36b4184b-a3c0-4e2e-9c6e-61bac4d2abc0",
            "keyword": "창스꿍스"
        }
    ],
    "success": true,
    "message": "키워드 조회 성공"
}

• Response failure Example:

{
    "success" : false,
    "message" : "키워드 조회 실패",
    "keywordList": null
}

2.Save Keyword

- 키워드 저장

• Endpoint: /keyword

• Method: POST

• Request:

  • userId: UUID
  • keyword: String

• Request Example:

{
    "userId" : "9f373112-8e93-4444-a403-a986f8bea4a3",
    "keyword" : "창스꿍스"
}

• Response:
  • success: Boolean
  • message: String
  • keywordId: UUID (unique)
• Response Success Example:

{
    "keywordId": "029ddb7d-f3aa-4ceb-939e-e62072706590",
    "success": true,
    "message": "키워드 등록 성공"
}

• Response Fail Example:

{
    "keywordId": null,
    "success": false,
    "message": "키워드 등록 시 DAO 저장 실패"
}

3. Update Keyword

- 키워드 수정

• Endpoint: /keyword

• Method: Put

• Request:

  • keywordId: UUID
  • userId: UUID
  • keyword: String

• Request Example:

{
    "keywordId": "36b4184b-a3c0-4e2e-9c6e-61bac4d2abc0",
    "userId" : "9f373112-8e93-4444-a403-a986f8bea4a3",
    "keyword" : "창스꿍스"
}

• Response:
  • success: Boolean
  • message: String
  • keywordId: UUID (unique)
• Response Success Example:

{
    "keywordId": "36b4184b-a3c0-4e2e-9c6e-61bac4d2abc0",
    "success": true,
    "message": "키워드 수정 성공"
}

• Response Fail Example:

{
    "keywordId": null,
    "success": false,
    "message": "키워드 수정 시 DAO 저장 실패"
}

4. Delete Keyword

- 키워드 삭제

• Endpoint: /keyword

• Method: Delete

• Request:

  • keywordId: UUID
  • userId: UUID

• Request Example:

{
    "keywordId" : "f7dd9d89-a0e9-4b97-bd0f-1db2608626b4",
    "userId" : "9f373112-8e93-4444-a403-a986f8bea4a3"
}

• Response:
  • success: Boolean
  • message: String
• Response Success Example:

{
    "success": true,
    "message": "키워드 삭제 성공"
}

• Response Fail Example:

{
    "success": false,
    "message": "키워드 삭제 실패"
}