Skip to content

AQ

Jump to bottom
6suhyeon edited this page Feb 15, 2025 · 1 revision

API Documentation

Endpoints

1. Get AQ

- AQ 전체 조회

  • EndPoint: /AQ/user/{userId}

  • Method: GET

  • Request: None

  • Response:

    • success: Boolean
    • message: String
    • AQList (aqId, question, answer, questionCreatedAt, answerCreatedAt, isAnswer)
      • aqId: UUID (unique)
      • question: String
      • answer: String
      • questionCreatedAt: LocalDateTime
      • answerCreatedAt: LocalDateTime
      • isAnswer: Boolean

  • Response Success Example:

{
    "success": true,
    "AQList": [
        {
            "aqId": "a74ecc81-1965-41cf-9916-01e5b1d32994",
            "question": "창현이형은 바보인가요??",
            "answer": "답변 : 마이크 테스트 완료, 창현이 형은 바보가 아니지만 농담으로 가볍게 놀려볼 수는 있겠죠. 물론 유머는 상황에 따라 다르게 받아들여질 수 있으니 적당히 하는 게 중요합니다. 웃음으로 분위기를 풀 수 있다면 좋겠지만, 괜히 오해를 살까 봐 조심해야 합니다. 결국에는 모두가 즐겁게 대화를 이어가는 게 가장 중요하겠죠? 그래서 지금은 그냥 웃으며 넘어가 보아요! 😊",
            "isAnswer": true,
            "questionCreatedAt": "2025-02-15T15:38:39.585838",
            "answerCreatedAt": "2025-02-15T16:15:25.530023"
        },
        {
            "aqId": "0e68a8f8-59e5-4cf9-b025-0c83342fb559",
            "question": "창현이형은 26살인가요?????",
            "answer": null,
            "isAnswer": false,
            "questionCreatedAt": "2025-02-15T15:38:49.266001",
            "answerCreatedAt": null
        },
        {
            "aqId": "63bf14fd-1fb2-4e65-99d9-3f786768fdac",
            "question": "하지만 마음만은 20살이라고 하던데 사실인가요??",
            "answer": null,
            "isAnswer": false,
            "questionCreatedAt": "2025-02-15T15:39:01.91804",
            "answerCreatedAt": null
        },
        {
            "aqId": "abfc3655-9b7c-4827-8c11-46d4bb3dc017",
            "question": "헤헤 형 바보",
            "answer": null,
            "isAnswer": false,
            "questionCreatedAt": "2025-02-15T15:39:38.447787",
            "answerCreatedAt": null
        }
    ],
    "message": "AQ 전체 조회 성공"
}
  • Response failure Example:
{
    "success" : false,
    "message" : "AQ 전체 조회 실패",
    "AQList": null
}

2.Save AQ

- AQ 유저 등록

  • Endpoint: /AQ

  • Method: POST

  • Request:

    • userId: UUID
    • question: String

  • Request Example:

{
    "userId" : "9f373112-8e93-4444-a403-a986f8bea4a3", 
    "question" : "안녕하세욥"
}
  • Response:
    • success: Boolean
    • message: String
    • AQId: UUID (unique)
  • Response Success Example:
{
    "AQId": "f21d63db-4153-4044-8e33-eb1325b130e9",
    "success": true,
    "message": "AQ 유저 등록 성공"
}
  • Response Fail Example:
{
    "AQId": null,
    "success": false,
    "message": "AQ 유저 등록 실패"
}

3. Update AQ

- AQ 어드민 답장 (관리자용)

  • Endpoint: /AQ

  • Method: Patch

  • Request:

    • aqId: UUID
    • answer: String

  • Request Example:

{
    "aqId" : "a74ecc81-1965-41cf-9916-01e5b1d32994",
    "answer" : "답변 : 마이크 테스트 완료, 창현이 형은 바보가 아니지만 농담으로 가볍게 놀려볼 수는 있겠죠. 물론 유머는 상황에 따라 다르게 받아들여질 수 있으니 적당히 하는 게 중요합니다. 웃음으로 분위기를 풀 수 있다면 좋겠지만, 괜히 오해를 살까 봐 조심해야 합니다. 결국에는 모두가 즐겁게 대화를 이어가는 게 가장 중요하겠죠? 그래서 지금은 그냥 웃으며 넘어가 보아요! 😊"
}
  • Response:
    • success: Boolean
    • message: String
    • keywordId: UUID (unique)
  • Response Success Example:
{
    "AQId": "0e68a8f8-59e5-4cf9-b025-0c83342fb559",
    "success": true,
    "message": "AQ 어드민 답장 성공"
}
  • Response Fail Example:
{
    "AQId": null,
    "success": false,
    "message": "AQ 어드민 답장 실패"
}

4. Delete AQ

- AQ 삭제

  • Endpoint: /AQ

  • Method: Delete

  • Request:

    • aqId: UUID
    • userId: UUID

  • Request Example:

{
    "aqId" : "f21d63db-4153-4044-8e33-eb1325b130e9",
    "userId" : "9f373112-8e93-4444-a403-a986f8bea4a3"
}
  • Response:
    • success: Boolean
    • message: String
  • Response Success Example:
{
    "success": true,
    "message": "AQ 삭제 성공"
}
  • Response Fail Example:
{
    "success": false,
    "message": "AQ 삭제 실패"
}

Clone this wiki locally