API Docs For CS-Broker Backend API

{
    "status" : "success",
    "data" : {
        "posts" : [
            { "id" : 1, "title" : "A blog post", "body" : "Some useful content" },
            { "id" : 2, "title" : "Another blog post", "body" : "More content" },
        ]
     }
}

{
    "status" : "fail",
    "data" : {
        "title" : "A title is required"
     }
}

{
    "status" : "error",
    "message" : "Unable to communicate with database"
}

회원가입을 위한 API입니다.

HTTP Method : POST
End-Point   : /api/v1/auth/signup

POST /api/v1/auth/signup HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Authorization: Bearer TEST-TOKEN
Content-Length: 82
Host: localhost:8080

{
  "email" : "test@test.com",
  "username" : "test",
  "password" : "Test123@!"
}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 94

{
  "status" : "success",
  "data" : {
    "id" : "870dbe47-0ef2-44dc-8d0d-c49fcfe047b1"
  }
}

{
  "email" : "test@test.com",
  "username" : "test",
  "password" : "Test123@!"
}

{
  "status" : "success",
  "data" : {
    "id" : "870dbe47-0ef2-44dc-8d0d-c49fcfe047b1"
  }
}

로그인을 위한 API입니다. ( 예외적으로, Back Office에서 함께 사용되는 API입니다. )

HTTP Method : POST
End-Point   : /api/v1/auth/login

POST /api/v1/auth/login HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Authorization: Bearer TEST-TOKEN
Content-Length: 59
Host: localhost:8080

{
  "email" : "test@test.com",
  "password" : "Test123@!"
}

HTTP/1.1 200 OK
Set-Cookie: refresh_token=refreshToken; Path=/; Max-Age=1; Expires=Sun, 21 Jan 2024 13:35:58 GMT; Secure; HttpOnly
Content-Type: application/json
Content-Length: 226

{
  "status" : "success",
  "data" : {
    "id" : "af96f9d0-302d-42cf-b0f6-11f81043a612",
    "username" : "seongil-kim",
    "email" : "seongil.kim@gmail.com",
    "role" : "ROLE_USER",
    "accessToken" : "accessToken"
  }
}

{
  "email" : "test@test.com",
  "password" : "Test123@!"
}

{
  "status" : "success",
  "data" : {
    "id" : "af96f9d0-302d-42cf-b0f6-11f81043a612",
    "username" : "seongil-kim",
    "email" : "seongil.kim@gmail.com",
    "role" : "ROLE_USER",
    "accessToken" : "accessToken"
  }
}

토큰 재발급을 위한 API입니다.

HTTP Method : GET
End-Point   : /api/v1/auth/refresh

GET /api/v1/auth/refresh HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Authorization: Bearer TEST-TOKEN
Host: localhost:8080

HTTP/1.1 200 OK
Set-Cookie: refresh_token=refreshToken; Path=/; Max-Age=1; Expires=Sun, 21 Jan 2024 13:35:58 GMT; Secure; HttpOnly
Content-Type: application/json
Content-Length: 78

{
  "status" : "success",
  "data" : {
    "accessToken" : "accessToken"
  }
}

{
  "status" : "success",
  "data" : {
    "accessToken" : "accessToken"
  }
}

토큰을 이용한 유저 정보 조회를 위한 API입니다.

HTTP Method : POST
End-Point   : /api/v1/auth/info

GET /api/v1/auth/info HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Authorization: Bearer TEST-TOKEN
Host: localhost:8080

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 182

{
  "status" : "success",
  "data" : {
    "id" : "623d94f3-083f-45dd-9abd-07ecd10e67cf",
    "username" : "admin",
    "email" : "admin@csbroker.io",
    "role" : "ROLE_ADMIN"
  }
}

{
  "status" : "success",
  "data" : {
    "id" : "623d94f3-083f-45dd-9abd-07ecd10e67cf",
    "username" : "admin",
    "email" : "admin@csbroker.io",
    "role" : "ROLE_ADMIN"
  }
}

비밀번호 변경 메일 전송을 위한 API입니다.
비밀번호 변경 메일에는 "프론트엔드주소/password-change/코드" 와 같은 값이 전달됩니다.
즉, 프론트엔드에서는 위 링크에 해당하는 비밀번호 변경 창을 만들어줘야합니다.

HTTP Method : POST
End-Point   : /api/v1/password/code

POST /api/v1/auth/password/code HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Authorization: Bearer TEST-TOKEN
Content-Length: 31
Host: localhost:8080

{
  "email" : "test@test.com"
}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 48

{
  "status" : "success",
  "data" : "success"
}

{
  "email" : "test@test.com"
}

{
  "status" : "success",
  "data" : "success"
}

비밀번호 변경을 위한 API입니다.
유저가 "프론트엔드주소/password-change/코드" 와 같은 값으로 접근 하였을 때,
코드와 새로운 비밀번호를 함께 전송하면 비밀번호가 새로운 비밀번호로 변경됩니다.

코드는 5분동안 유효하며, 코드와 새로운 비밀번호를 전송해야 새로운 비밀번호로 성공적으로 변경됩니다.

HTTP Method : PUT
End-Point   : /api/v1/password/change

PUT /api/v1/auth/password/change HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Authorization: Bearer TEST-TOKEN
Content-Length: 51
Host: localhost:8080

{
  "code" : "123456",
  "password" : "Test123@!"
}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 48

{
  "status" : "success",
  "data" : "success"
}

{
  "code" : "123456",
  "password" : "Test123@!"
}

{
  "status" : "success",
  "data" : "success"
}

메인페이지 통계 조회를 위한 API입니다.

HTTP Method : GET
End-Point   : /api/v1/stats

GET /api/v1/stats HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Authorization: Bearer TEST-TOKEN
Host: localhost:8080

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 118

{
  "status" : "success",
  "data" : {
    "problemCnt" : 10,
    "gradableProblemCnt" : 10,
    "userCnt" : 100
  }
}

{
  "status" : "success",
  "data" : {
    "problemCnt" : 10,
    "gradableProblemCnt" : 10,
    "userCnt" : 100
  }
}

기술 스택 데이터 조회를 위한 API입니다.

HTTP Method : GET
End-Point   : /api/v1/techs

GET /api/v1/techs?query=a HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Authorization: Bearer TEST-TOKEN
Host: localhost:8080

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 59

{
  "status" : "success",
  "data" : [ "aws", "android" ]
}

{
  "status" : "success",
  "data" : [ "aws", "android" ]
}

랭킹 리스트 조회를 위한 API입니다.

HTTP Method : GET
End-Point   : /api/v1/ranks

GET /api/v1/ranks?size=3&page=0 HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Authorization: Bearer TEST-TOKEN
Host: localhost:8080

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 281

{
  "status" : "success",
  "data" : {
    "size" : 3,
    "totalPage" : 10,
    "currentPage" : 0,
    "numberOfElements" : 1,
    "contents" : [ {
      "id" : "0b58a8cb-6b24-457d-a82a-f07c6a6a00de",
      "username" : "test",
      "rank" : 1,
      "score" : 10.0
    } ]
  }
}

{
  "status" : "success",
  "data" : {
    "size" : 3,
    "totalPage" : 10,
    "currentPage" : 0,
    "numberOfElements" : 1,
    "contents" : [ {
      "id" : "0b58a8cb-6b24-457d-a82a-f07c6a6a00de",
      "username" : "test",
      "rank" : 1,
      "score" : 10.0
    } ]
  }
}

서술형 문제 단건 조회를 위한 API입니다.

HTTP Method : GET
End-Point   : /api/v1/problems/long/{problem_id:Long}

GET /api/v1/problems/long/1 HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Authorization: Bearer TEST-TOKEN
Host: localhost:8080

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 438

{
  "status" : "success",
  "data" : {
    "id" : 1,
    "title" : "Long problem title",
    "tags" : [ "tag1", "tag2" ],
    "description" : "Long problem description",
    "avgScore" : 10.0,
    "topScore" : 10.0,
    "bottomScore" : 0.0,
    "score" : 10.0,
    "totalSubmission" : 10,
    "isSolved" : true,
    "isGradable" : true,
    "likeCount" : 10,
    "bookmarkCount" : 10,
    "isLiked" : true,
    "isBookmarked" : true
  }
}

{
  "status" : "success",
  "data" : {
    "id" : 1,
    "title" : "Long problem title",
    "tags" : [ "tag1", "tag2" ],
    "description" : "Long problem description",
    "avgScore" : 10.0,
    "topScore" : 10.0,
    "bottomScore" : 0.0,
    "score" : 10.0,
    "totalSubmission" : 10,
    "isSolved" : true,
    "isGradable" : true,
    "likeCount" : 10,
    "bookmarkCount" : 10,
    "isLiked" : true,
    "isBookmarked" : true
  }
}

서술형 문제 채점을 위한 API입니다.

HTTP Method : POST
End-Point   : /api/v1/problems/long/{problem_id:Long}/grade

단답형 문제 단건 조회를 위한 API입니다.

HTTP Method : GET
End-Point   : /api/v1/problems/short/{problem_id:Long}

GET /api/v1/problems/short/1 HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Authorization: Bearer TEST-TOKEN
Host: localhost:8080

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 438

{
  "status" : "success",
  "data" : {
    "id" : 1,
    "title" : "problem title",
    "tags" : [ "tag1", "tag2" ],
    "description" : "problem description",
    "correctSubmission" : 10,
    "correctUserCnt" : 10,
    "totalSubmission" : 10,
    "answerLength" : 10,
    "isEnglish" : true,
    "isSolved" : true,
    "score" : 10.0,
    "likeCount" : 10,
    "bookmarkCount" : 10,
    "isLiked" : true,
    "isBookmarked" : true
  }
}

{
  "status" : "success",
  "data" : {
    "id" : 1,
    "title" : "problem title",
    "tags" : [ "tag1", "tag2" ],
    "description" : "problem description",
    "correctSubmission" : 10,
    "correctUserCnt" : 10,
    "totalSubmission" : 10,
    "answerLength" : 10,
    "isEnglish" : true,
    "isSolved" : true,
    "score" : 10.0,
    "likeCount" : 10,
    "bookmarkCount" : 10,
    "isLiked" : true,
    "isBookmarked" : true
  }
}

단답형 문제 채점을 위한 API입니다.

HTTP Method : POST
End-Point   : /api/v1/problems/short/{problem_id:Long}/grade

POST /api/v1/problems/short/1/grade HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Authorization: Bearer TEST-TOKEN
Content-Length: 30
Host: localhost:8080

{
  "answer" : "user answer"
}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 427

{
  "status" : "success",
  "data" : {
    "gradingHistoryId" : 1,
    "problemId" : 1,
    "title" : "problem title",
    "tags" : [ "tag1", "tag2" ],
    "description" : "problem description",
    "correctSubmission" : 10,
    "correctUserCnt" : 10,
    "totalSubmission" : 10,
    "userAnswer" : "user answer",
    "answerLength" : 10,
    "isAnswer" : false,
    "score" : 10.0,
    "correctAnswer" : "correct answer"
  }
}

{
  "status" : "success",
  "data" : {
    "gradingHistoryId" : 1,
    "problemId" : 1,
    "title" : "problem title",
    "tags" : [ "tag1", "tag2" ],
    "description" : "problem description",
    "correctSubmission" : 10,
    "correctUserCnt" : 10,
    "totalSubmission" : 10,
    "userAnswer" : "user answer",
    "answerLength" : 10,
    "isAnswer" : false,
    "score" : 10.0,
    "correctAnswer" : "correct answer"
  }
}

객관식 문제 단건 조회를 위한 API입니다.

HTTP Method : GET
End-Point   : /api/v1/problems/multiple/{problem_id:Long}

GET /api/v1/problems/multiple/1 HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Authorization: Bearer TEST-TOKEN
Host: localhost:8080

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 489

{
  "status" : "success",
  "data" : {
    "id" : 1,
    "title" : "problem title",
    "tags" : [ "tag1", "tag2" ],
    "description" : "problem description",
    "correctSubmission" : 10,
    "correctUserCnt" : 10,
    "totalSubmission" : 10,
    "choices" : [ {
      "id" : 1,
      "content" : "123"
    } ],
    "isSolved" : true,
    "isMultipleAnswer" : true,
    "score" : 10.0,
    "likeCount" : 10,
    "bookmarkCount" : 10,
    "isLiked" : true,
    "isBookmarked" : true
  }
}

{
  "status" : "success",
  "data" : {
    "id" : 1,
    "title" : "problem title",
    "tags" : [ "tag1", "tag2" ],
    "description" : "problem description",
    "correctSubmission" : 10,
    "correctUserCnt" : 10,
    "totalSubmission" : 10,
    "choices" : [ {
      "id" : 1,
      "content" : "123"
    } ],
    "isSolved" : true,
    "isMultipleAnswer" : true,
    "score" : 10.0,
    "likeCount" : 10,
    "bookmarkCount" : 10,
    "isLiked" : true,
    "isBookmarked" : true
  }
}

객관식 문제 채점을 위한 API입니다.

HTTP Method : POST
End-Point   : /api/v1/problems/multiple/{problem_id:Long}/grade

POST /api/v1/problems/multiple/1/grade HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Authorization: Bearer TEST-TOKEN
Content-Length: 25
Host: localhost:8080

{
  "answerIds" : [ 1 ]
}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 425

{
  "status" : "success",
  "data" : {
    "gradingHistoryId" : 1,
    "problemId" : 1,
    "title" : "problem title",
    "tags" : [ "tag1", "tag2" ],
    "description" : "problem description",
    "correctSubmission" : 10,
    "correctUserCnt" : 10,
    "totalSubmission" : 10,
    "choices" : [ {
      "id" : 1,
      "content" : "123"
    } ],
    "userAnswerIds" : [ 1 ],
    "isAnswer" : true,
    "score" : 10.0
  }
}

{
  "status" : "success",
  "data" : {
    "gradingHistoryId" : 1,
    "problemId" : 1,
    "title" : "problem title",
    "tags" : [ "tag1", "tag2" ],
    "description" : "problem description",
    "correctSubmission" : 10,
    "correctUserCnt" : 10,
    "totalSubmission" : 10,
    "choices" : [ {
      "id" : 1,
      "content" : "123"
    } ],
    "userAnswerIds" : [ 1 ],
    "isAnswer" : true,
    "score" : 10.0
  }
}

문제 검색을 위한 API입니다.

HTTP Method : GET
End-Point   : /api/v1/problems
Req Params  : query, tags, isSolved, page, size, type, isGradable

GET /api/v1/problems?query=test&isSolved=false&tags=os,ds&page=0&size=10&type=long&isGradable=false HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Authorization: Bearer TEST-TOKEN
Host: localhost:8080

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 335

{
  "status" : "success",
  "data" : {
    "contents" : [ {
      "id" : 1,
      "title" : "test",
      "tags" : [ "os", "ds" ],
      "avgScore" : 1.0,
      "totalSubmission" : 10,
      "type" : "long"
    } ],
    "currentPage" : 0,
    "totalPages" : 1,
    "totalElements" : 1,
    "numberOfElements" : 1,
    "size" : 10
  }
}

{
  "status" : "success",
  "data" : {
    "contents" : [ {
      "id" : 1,
      "title" : "test",
      "tags" : [ "os", "ds" ],
      "avgScore" : 1.0,
      "totalSubmission" : 10,
      "type" : "long"
    } ],
    "currentPage" : 0,
    "totalPages" : 1,
    "totalElements" : 1,
    "numberOfElements" : 1,
    "size" : 10
  }
}

문제 채점 결과에 대한 평가 의견을 남기기 위한 API입니다.

HTTP Method : POST
End-Point   : /api/v1/problems/grade/{problem_id:Long}/assessment

POST /api/v1/problems/grade/1/assessment HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Authorization: Bearer TEST-TOKEN
Content-Length: 53
Host: localhost:8080

{
  "assessmentType" : "GOOD",
  "content" : "test"
}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 57

{
  "status" : "success",
  "data" : {
    "id" : 1
  }
}

{
  "assessmentType" : "GOOD",
  "content" : "test"
}

{
  "status" : "success",
  "data" : {
    "id" : 1
  }
}

단답형 문제 단건 조회를 위한 API입니다.

HTTP Method : GET
End-Point   : /api/v2/problems/short/{problem_id:Long}

GET /api/v2/problems/short/1 HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Authorization: Bearer TEST-TOKEN
Host: localhost:8080

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 346

{
  "status" : "success",
  "data" : {
    "id" : 1,
    "title" : "problem title",
    "tags" : [ "tag1", "tag2" ],
    "description" : "problem description",
    "correctSubmission" : 10,
    "correctUserCnt" : 10,
    "totalSubmission" : 10,
    "answerLength" : 10,
    "consistOf" : "ENGLISH",
    "isSolved" : true,
    "score" : 10.0
  }
}

{
  "status" : "success",
  "data" : {
    "id" : 1,
    "title" : "problem title",
    "tags" : [ "tag1", "tag2" ],
    "description" : "problem description",
    "correctSubmission" : 10,
    "correctUserCnt" : 10,
    "totalSubmission" : 10,
    "answerLength" : 10,
    "consistOf" : "ENGLISH",
    "isSolved" : true,
    "score" : 10.0
  }
}

문제 이의 제기를 위한 API입니다.

HTTP Method : POST
End-Point   : /api/v2/problems/{problem_id:Long}/challenge

POST /api/v2/problems/1/challenge HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Authorization: Bearer TEST-TOKEN
Content-Length: 69
Host: localhost:8080

{
  "content" : "이것은 이의제기를 위한 내용입니다."
}

{
  "content" : "이것은 이의제기를 위한 내용입니다."
}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 43

{
  "status" : "success",
  "data" : true
}

{
  "status" : "success",
  "data" : true
}

문제를 좋아요하기 위한 API입니다.
HTTP Method : POST
End-Point   : /api/v2/problems/{postId}/like

POST /api/v2/problems/1/like HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Authorization: Bearer TEST-TOKEN
Host: localhost:8080

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 26

{
  "status" : "success"
}

{
  "status" : "success"
}

문제를 북마크하기 위한 API입니다.
HTTP Method : POST
End-Point   : /api/v2/problems/{postId}/bookmark

POST /api/v2/problems/1/bookmark HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Authorization: Bearer TEST-TOKEN
Host: localhost:8080

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 26

{
  "status" : "success"
}

{
  "status" : "success"
}

유저 조회를 위한 API입니다.

HTTP Method : GET
End-Point   : /api/v1/users/{user_id:UUID}

GET /api/v1/users/a6a9affc-9707-4ed7-8eff-10d5ddb6618a HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Authorization: Bearer TEST-TOKEN
Host: localhost:8080

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 414

{
  "status" : "success",
  "data" : {
    "id" : "293e7ba5-cf6b-48d2-aceb-98648d34b38c",
    "email" : "email",
    "username" : "username",
    "role" : "ROLE_USER",
    "major" : "major",
    "job" : "job",
    "jobObjective" : "jobObjective",
    "techs" : [ "tech" ],
    "profileImgUrl" : "profileImageUrl",
    "githubUrl" : "githubUrl",
    "linkedinUrl" : "linkedinUrl",
    "providerType" : "LOCAL"
  }
}

{
  "status" : "success",
  "data" : {
    "id" : "293e7ba5-cf6b-48d2-aceb-98648d34b38c",
    "email" : "email",
    "username" : "username",
    "role" : "ROLE_USER",
    "major" : "major",
    "job" : "job",
    "jobObjective" : "jobObjective",
    "techs" : [ "tech" ],
    "profileImgUrl" : "profileImageUrl",
    "githubUrl" : "githubUrl",
    "linkedinUrl" : "linkedinUrl",
    "providerType" : "LOCAL"
  }
}

유저 전체 조회를 위한 API입니다.

HTTP Method : GET
End-Point   : /api/v1/users

GET /api/v1/users HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Authorization: Bearer TEST-TOKEN
Host: localhost:8080

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 418

{
  "status" : "success",
  "data" : [ {
    "id" : "81fba690-31d8-4aa4-8e13-5b1d6af4394e",
    "email" : "email",
    "username" : "username",
    "role" : "ROLE_USER",
    "major" : "major",
    "job" : "job",
    "jobObjective" : "jobObjective",
    "techs" : [ "tech" ],
    "profileImgUrl" : "profileImageUrl",
    "githubUrl" : "githubUrl",
    "linkedinUrl" : "linkedinUrl",
    "providerType" : "LOCAL"
  } ]
}

{
  "status" : "success",
  "data" : [ {
    "id" : "81fba690-31d8-4aa4-8e13-5b1d6af4394e",
    "email" : "email",
    "username" : "username",
    "role" : "ROLE_USER",
    "major" : "major",
    "job" : "job",
    "jobObjective" : "jobObjective",
    "techs" : [ "tech" ],
    "profileImgUrl" : "profileImageUrl",
    "githubUrl" : "githubUrl",
    "linkedinUrl" : "linkedinUrl",
    "providerType" : "LOCAL"
  } ]
}

유저 정보 수정을 위한 API입니다.

HTTP Method : PUT
End-Point   : /api/v1/users/{userID: UUID}

PUT /api/v1/users/bb6fa695-dc16-4cb1-95d9-8b5c06cd450a HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Authorization: Bearer TEST-TOKEN
Content-Length: 436
Host: localhost:8080

{
  "profileImageUrl" : "https://test.com/test.png",
  "username" : "test-admin-update",
  "originalPassword" : "password",
  "password" : "changePassword123!",
  "major" : "환경공학",
  "job" : "대학생",
  "jobObjective" : "프론트엔드 개발자",
  "techs" : [ "react", "typescript" ],
  "githubUrl" : "https://github.com/Kim-Hyunjo",
  "linkedinUrl" : "https://www.linkedin.com/in/%EC%9E%AC%EC%9B%90-%EB%AF%BC-2b5149211"
}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 414

{
  "status" : "success",
  "data" : {
    "id" : "e4b9c356-c7a2-4180-bb55-1ab0068a8c21",
    "email" : "email",
    "username" : "username",
    "role" : "ROLE_USER",
    "major" : "major",
    "job" : "job",
    "jobObjective" : "jobObjective",
    "techs" : [ "tech" ],
    "profileImgUrl" : "profileImageUrl",
    "githubUrl" : "githubUrl",
    "linkedinUrl" : "linkedinUrl",
    "providerType" : "LOCAL"
  }
}

{
  "profileImageUrl" : "https://test.com/test.png",
  "username" : "test-admin-update",
  "originalPassword" : "password",
  "password" : "changePassword123!",
  "major" : "환경공학",
  "job" : "대학생",
  "jobObjective" : "프론트엔드 개발자",
  "techs" : [ "react", "typescript" ],
  "githubUrl" : "https://github.com/Kim-Hyunjo",
  "linkedinUrl" : "https://www.linkedin.com/in/%EC%9E%AC%EC%9B%90-%EB%AF%BC-2b5149211"
}

{
  "status" : "success",
  "data" : {
    "id" : "e4b9c356-c7a2-4180-bb55-1ab0068a8c21",
    "email" : "email",
    "username" : "username",
    "role" : "ROLE_USER",
    "major" : "major",
    "job" : "job",
    "jobObjective" : "jobObjective",
    "techs" : [ "tech" ],
    "profileImgUrl" : "profileImageUrl",
    "githubUrl" : "githubUrl",
    "linkedinUrl" : "linkedinUrl",
    "providerType" : "LOCAL"
  }
}

유저 삭제를 위한 API입니다.

HTTP Method : DELETE
End-Point   : /api/v1/users/{userID: UUID}

DELETE /api/v1/users/d2d8b3f2-360d-4b43-8161-a54f9aa12e3c HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Authorization: Bearer TEST-TOKEN
Host: localhost:8080

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 115

{
  "status" : "success",
  "data" : {
    "id" : "d2d8b3f2-360d-4b43-8161-a54f9aa12e3c",
    "result" : true
  }
}

{
  "status" : "success",
  "data" : {
    "id" : "d2d8b3f2-360d-4b43-8161-a54f9aa12e3c",
    "result" : true
  }
}

유저 통계 조회를 위한 API입니다.

HTTP Method : GET
End-Point   : /api/v1/users/{user_id}/stats

GET /api/v1/users/be866e92-93e8-4b46-9216-1d640fe857ea/stats HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Authorization: Bearer TEST-TOKEN
Host: localhost:8080

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 514

{
  "status" : "success",
  "data" : {
    "correctAnsweredProblem" : [ {
      "id" : 1,
      "type" : "long",
      "title" : "Long Problem"
    } ],
    "wrongAnsweredProblem" : [ {
      "id" : 2,
      "type" : "short",
      "title" : "Short Problem"
    } ],
    "partialAnsweredProblem" : [ {
      "id" : 3,
      "type" : "short",
      "title" : "Short Problem"
    } ],
    "count" : {
      "os" : 1,
      "network" : 2,
      "ds" : 3,
      "db" : 4
    },
    "rank" : 1,
    "score" : 10.0
  }
}

{
  "status" : "success",
  "data" : {
    "correctAnsweredProblem" : [ {
      "id" : 1,
      "type" : "long",
      "title" : "Long Problem"
    } ],
    "wrongAnsweredProblem" : [ {
      "id" : 2,
      "type" : "short",
      "title" : "Short Problem"
    } ],
    "partialAnsweredProblem" : [ {
      "id" : 3,
      "type" : "short",
      "title" : "Short Problem"
    } ],
    "count" : {
      "os" : 1,
      "network" : 2,
      "ds" : 3,
      "db" : 4
    },
    "rank" : 1,
    "score" : 10.0
  }
}

Notification 조회를 위한 API입니다.

HTTP Method : GET
End-Point   : /api/v1/notifications
Req Params : page, size

GET /api/v1/notifications?page=0&size=10 HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Authorization: Bearer TEST-TOKEN
Host: localhost:8080

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 331

{
  "status" : "success",
  "data" : {
    "contents" : [ {
      "id" : 1,
      "content" : "content",
      "link" : "link",
      "isRead" : false,
      "createdAt" : "2024-01-21T13:35:58.02883887"
    } ],
    "currentPage" : 0,
    "totalPages" : 1,
    "totalElements" : 1,
    "numberOfElements" : 1,
    "size" : 10
  }
}

{
  "status" : "success",
  "data" : {
    "contents" : [ {
      "id" : 1,
      "content" : "content",
      "link" : "link",
      "isRead" : false,
      "createdAt" : "2024-01-21T13:35:58.02883887"
    } ],
    "currentPage" : 0,
    "totalPages" : 1,
    "totalElements" : 1,
    "numberOfElements" : 1,
    "size" : 10
  }
}

Notification 읽음 처리를 위한 API입니다.

HTTP Method : PUT
End-Point   : /api/v1/notifications/read/{notification_id}

PUT /api/v1/notifications/read/1 HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Authorization: Bearer TEST-TOKEN
Host: localhost:8080

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 65

{
  "status" : "success",
  "data" : {
    "success" : true
  }
}

{
  "status" : "success",
  "data" : {
    "success" : true
  }
}

Notification 여러건의 읽음 처리를 위한 API입니다.

HTTP Method : PUT
End-Point   : /api/v1/notifications/read

PUT /api/v1/notifications/read HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Authorization: Bearer TEST-TOKEN
Content-Length: 19
Host: localhost:8080

{
  "ids" : [ 1 ]
}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 65

{
  "status" : "success",
  "data" : {
    "success" : true
  }
}

{
  "status" : "success",
  "data" : {
    "success" : true
  }
}

읽지않은 Notification 개수 조회를 위한 API입니다.

HTTP Method : GET
End-Point   : /api/v1/notifications/count

GET /api/v1/notifications/count HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Authorization: Bearer TEST-TOKEN
Host: localhost:8080

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 61

{
  "status" : "success",
  "data" : {
    "count" : 10
  }
}

{
  "status" : "success",
  "data" : {
    "count" : 10
  }
}

문제 세트 전체 조회를 위한 API입니다.

HTTP Method : GET
End-Point   : /api/v1/problem-sets

GET /api/v1/problem-sets HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Authorization: Bearer TEST-TOKEN
Host: localhost:8080

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 166

{
  "status" : "success",
  "data" : [ {
    "id" : 1,
    "problemCnt" : 0,
    "name" : "test 문제세트",
    "description" : "테스트용 문제세트"
  } ]
}

{
  "status" : "success",
  "data" : [ {
    "id" : 1,
    "problemCnt" : 0,
    "name" : "test 문제세트",
    "description" : "테스트용 문제세트"
  } ]
}

문제 세트 단건 조회를 위한 API입니다.

HTTP Method : GET
End-Point   : /api/v1/problem-sets/{problemSetId}

GET /api/v1/problem-sets/1 HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Authorization: Bearer TEST-TOKEN
Host: localhost:8080

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 676

{
  "status" : "success",
  "data" : {
    "id" : 1,
    "problems" : [ {
      "id" : 1,
      "title" : "test 문제",
      "tags" : [ "DS", "Network" ],
      "avgScore" : 10.0,
      "totalSubmission" : 100,
      "type" : "long"
    }, {
      "id" : 2,
      "title" : "test 문제",
      "tags" : [ "DS", "Network" ],
      "avgScore" : 10.0,
      "totalSubmission" : 100,
      "type" : "multiple"
    }, {
      "id" : 3,
      "title" : "test 문제",
      "tags" : [ "DS", "Network" ],
      "avgScore" : 10.0,
      "totalSubmission" : 100,
      "type" : "short"
    } ],
    "name" : "test 문제세트",
    "description" : "테스트용 문제세트"
  }
}

{
  "status" : "success",
  "data" : {
    "id" : 1,
    "problems" : [ {
      "id" : 1,
      "title" : "test 문제",
      "tags" : [ "DS", "Network" ],
      "avgScore" : 10.0,
      "totalSubmission" : 100,
      "type" : "long"
    }, {
      "id" : 2,
      "title" : "test 문제",
      "tags" : [ "DS", "Network" ],
      "avgScore" : 10.0,
      "totalSubmission" : 100,
      "type" : "multiple"
    }, {
      "id" : 3,
      "title" : "test 문제",
      "tags" : [ "DS", "Network" ],
      "avgScore" : 10.0,
      "totalSubmission" : 100,
      "type" : "short"
    } ],
    "name" : "test 문제세트",
    "description" : "테스트용 문제세트"
  }
}

글을 생성하기 위한 API입니다.

HTTP Method : POST
End-Point   : /api/v1/posts

POST /api/v1/posts HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Content-Length: 46
Host: localhost:8080

{
  "problemId" : 1,
  "content" : "content"
}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 40

{
  "status" : "success",
  "data" : 1
}

{
  "problemId" : 1,
  "content" : "content"
}

{
  "status" : "success",
  "data" : 1
}

글을 조회하기 위한 API입니다.

HTTP Method : GET
End-Point   : /api/v1/problems/{problemId}/posts

GET /api/v1/problems/1/posts HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Host: localhost:8080

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 469

{
  "status" : "success",
  "data" : [ {
    "id" : 1,
    "content" : "CONTENT",
    "username" : "USER",
    "userId" : "efa1d7d1-3fc1-4cef-a1f8-263050594ab2",
    "likeCount" : 1,
    "isLiked" : true,
    "comments" : [ {
      "id" : 1,
      "content" : "CONTENT",
      "username" : "USER",
      "userId" : "3b7f1958-4bc5-421c-b3aa-650a68200938",
      "likeCount" : 1,
      "isLiked" : true,
      "createdAt" : "2024-01-21T13:35:59.272512244"
    } ]
  } ]
}

{
  "status" : "success",
  "data" : [ {
    "id" : 1,
    "content" : "CONTENT",
    "username" : "USER",
    "userId" : "efa1d7d1-3fc1-4cef-a1f8-263050594ab2",
    "likeCount" : 1,
    "isLiked" : true,
    "comments" : [ {
      "id" : 1,
      "content" : "CONTENT",
      "username" : "USER",
      "userId" : "3b7f1958-4bc5-421c-b3aa-650a68200938",
      "likeCount" : 1,
      "isLiked" : true,
      "createdAt" : "2024-01-21T13:35:59.272512244"
    } ]
  } ]
}

글을 삭제하기 위한 API입니다.

HTTP Method : DELETE
End-Point   : /api/v1/posts/{postId}

DELETE /api/v1/posts/1 HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Host: localhost:8080

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 26

{
  "status" : "success"
}

{
  "status" : "success"
}

글을 좋아요하기 위한 API입니다.

HTTP Method : POST
End-Point   : /api/v1/posts/{postId}/like

POST /api/v1/posts/1/like HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Host: localhost:8080

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 26

{
  "status" : "success"
}

{
  "status" : "success"
}

댓글을 생성하기 위한 API입니다.

HTTP Method : POST
End-Point   : /api/v1/comments

POST /api/v1/comments HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Content-Length: 43
Host: localhost:8080

{
  "postId" : 1,
  "content" : "content"
}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 40

{
  "status" : "success",
  "data" : 1
}

{
  "postId" : 1,
  "content" : "content"
}

{
  "status" : "success",
  "data" : 1
}

댓글을 삭제하기 위한 API입니다.

HTTP Method : DELETE
End-Point   : /api/v1/comments/{commentId}

DELETE /api/v1/comments/1 HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Host: localhost:8080

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 26

{
  "status" : "success"
}

{
  "status" : "success"
}

서술형 문제를 생성하기 위한 API입니다.

HTTP Method : POST
End-Point   : /api/admin/problems/long

POST /api/admin/problems/long HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Authorization: Bearer TEST-TOKEN
Content-Length: 264
Host: localhost:8080

{
  "title" : "test",
  "description" : "test",
  "standardAnswers" : [ "test" ],
  "tags" : [ "db", "network" ],
  "gradingStandards" : [ {
    "content" : "keyword-1",
    "score" : 1.0,
    "type" : "KEYWORD"
  } ],
  "isGradable" : false,
  "isActive" : true
}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 57

{
  "status" : "success",
  "data" : {
    "id" : 1
  }
}

{
  "title" : "test",
  "description" : "test",
  "standardAnswers" : [ "test" ],
  "tags" : [ "db", "network" ],
  "gradingStandards" : [ {
    "content" : "keyword-1",
    "score" : 1.0,
    "type" : "KEYWORD"
  } ],
  "isGradable" : false,
  "isActive" : true
}

{
  "status" : "success",
  "data" : {
    "id" : 1
  }
}

단답형 문제 단건 조회를 위한 API입니다.

HTTP Method : GET
End-Point   : /api/admin/problems/long/{problem_id:Long}

GET /api/admin/problems/long/1 HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Authorization: Bearer TEST-TOKEN
Host: localhost:8080

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 363

{
  "status" : "success",
  "data" : {
    "id" : 1,
    "title" : "title",
    "description" : "description",
    "standardAnswers" : [ "answer" ],
    "tags" : [ "tag1", "tag2" ],
    "gradingStandards" : [ {
      "id" : 1,
      "content" : "content",
      "score" : 1.0,
      "type" : "KEYWORD"
    } ],
    "isActive" : true,
    "isGradable" : true
  }
}

{
  "status" : "success",
  "data" : {
    "id" : 1,
    "title" : "title",
    "description" : "description",
    "standardAnswers" : [ "answer" ],
    "tags" : [ "tag1", "tag2" ],
    "gradingStandards" : [ {
      "id" : 1,
      "content" : "content",
      "score" : 1.0,
      "type" : "KEYWORD"
    } ],
    "isActive" : true,
    "isGradable" : true
  }
}

서술형 문제 검색을 위한 API입니다.

HTTP Method : GET
End-Point   : /api/admin/problems/long
Req Params  : id, title, description page, size

GET /api/admin/problems/long?title=title&description=description&size=10&page=0 HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Authorization: Bearer TEST-TOKEN
Host: localhost:8080

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 303

{
  "status" : "success",
  "data" : {
    "problems" : [ {
      "id" : 1,
      "title" : "title",
      "creator" : "creator",
      "avgKeywordScore" : 1.0,
      "avgContentScore" : 1.0,
      "userAnswerCnt" : 1,
      "isActive" : true
    } ],
    "totalPages" : 1,
    "totalElements" : 1
  }
}

{
  "status" : "success",
  "data" : {
    "problems" : [ {
      "id" : 1,
      "title" : "title",
      "creator" : "creator",
      "avgKeywordScore" : 1.0,
      "avgContentScore" : 1.0,
      "userAnswerCnt" : 1,
      "isActive" : true
    } ],
    "totalPages" : 1,
    "totalElements" : 1
  }
}

서술형 문제 수정를 위한 API입니다.

HTTP Method : PUT
End-Point   : /api/admin/problems/long/{problem_id:Long}

PUT /api/admin/problems/long/1 HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Authorization: Bearer TEST-TOKEN
Content-Length: 264
Host: localhost:8080

{
  "title" : "test",
  "description" : "test",
  "standardAnswers" : [ "test" ],
  "tags" : [ "db", "network" ],
  "gradingStandards" : [ {
    "content" : "keyword-1",
    "score" : 1.0,
    "type" : "KEYWORD"
  } ],
  "isGradable" : false,
  "isActive" : true
}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 57

{
  "status" : "success",
  "data" : {
    "id" : 1
  }
}

{
  "title" : "test",
  "description" : "test",
  "standardAnswers" : [ "test" ],
  "tags" : [ "db", "network" ],
  "gradingStandards" : [ {
    "content" : "keyword-1",
    "score" : 1.0,
    "type" : "KEYWORD"
  } ],
  "isGradable" : false,
  "isActive" : true
}

{
  "status" : "success",
  "data" : {
    "id" : 1
  }
}

객관식 문제를 생성하기 위한 API입니다.

HTTP Method : POST
End-Point   : /api/admin/problems/multiple

POST /api/admin/problems/multiple HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Authorization: Bearer TEST-TOKEN
Content-Length: 274
Host: localhost:8080

{
  "title" : "test",
  "description" : "test",
  "tags" : [ "db", "network" ],
  "choices" : [ {
    "content" : "choice-1",
    "isAnswer" : true
  }, {
    "content" : "choice-2",
    "isAnswer" : false
  } ],
  "score" : 5.0,
  "isGradable" : true,
  "isActive" : true
}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 57

{
  "status" : "success",
  "data" : {
    "id" : 1
  }
}

{
  "title" : "test",
  "description" : "test",
  "tags" : [ "db", "network" ],
  "choices" : [ {
    "content" : "choice-1",
    "isAnswer" : true
  }, {
    "content" : "choice-2",
    "isAnswer" : false
  } ],
  "score" : 5.0,
  "isGradable" : true,
  "isActive" : true
}

{
  "status" : "success",
  "data" : {
    "id" : 1
  }
}

객관식 문제 단건 조회를 위한 API입니다.

HTTP Method : GET
End-Point   : /api/admin/problems/multiple/{problem_id:Long}

GET /api/admin/problems/multiple/1 HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Authorization: Bearer TEST-TOKEN
Host: localhost:8080

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 383

{
  "status" : "success",
  "data" : {
    "id" : 1,
    "title" : "test",
    "description" : "test",
    "tags" : [ "db", "network" ],
    "isMultiple" : true,
    "choiceData" : [ {
      "content" : "choice-1",
      "isAnswer" : true
    }, {
      "content" : "choice-2",
      "isAnswer" : false
    } ],
    "score" : 5.0,
    "isActive" : true,
    "isGradable" : true
  }
}

{
  "status" : "success",
  "data" : {
    "id" : 1,
    "title" : "test",
    "description" : "test",
    "tags" : [ "db", "network" ],
    "isMultiple" : true,
    "choiceData" : [ {
      "content" : "choice-1",
      "isAnswer" : true
    }, {
      "content" : "choice-2",
      "isAnswer" : false
    } ],
    "score" : 5.0,
    "isActive" : true,
    "isGradable" : true
  }
}

객관식 문제 검색을 위한 API입니다.

HTTP Method : GET
End-Point   : /api/admin/problems/multiple
Req Params  : id, title, description page, size

GET /api/admin/problems/multiple?title=test&description=t&size=5&page=1 HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Authorization: Bearer TEST-TOKEN
Host: localhost:8080

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 267

{
  "status" : "success",
  "data" : {
    "problems" : [ {
      "id" : 1,
      "title" : "title",
      "creator" : "creator",
      "answerRate" : 1.0,
      "userAnswerCnt" : 1,
      "isActive" : true
    } ],
    "totalPages" : 1,
    "totalElements" : 1
  }
}

{
  "status" : "success",
  "data" : {
    "problems" : [ {
      "id" : 1,
      "title" : "title",
      "creator" : "creator",
      "answerRate" : 1.0,
      "userAnswerCnt" : 1,
      "isActive" : true
    } ],
    "totalPages" : 1,
    "totalElements" : 1
  }
}

객관식 문제 수정를 위한 API입니다.

HTTP Method : PUT
End-Point   : /api/admin/problems/multiple/{problem_id:Long}

PUT /api/admin/problems/multiple/1 HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Authorization: Bearer TEST-TOKEN
Content-Length: 274
Host: localhost:8080

{
  "title" : "test",
  "description" : "test",
  "tags" : [ "db", "network" ],
  "choices" : [ {
    "content" : "choice-1",
    "isAnswer" : true
  }, {
    "content" : "choice-2",
    "isAnswer" : false
  } ],
  "score" : 5.0,
  "isGradable" : true,
  "isActive" : true
}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 57

{
  "status" : "success",
  "data" : {
    "id" : 1
  }
}

{
  "title" : "test",
  "description" : "test",
  "tags" : [ "db", "network" ],
  "choices" : [ {
    "content" : "choice-1",
    "isAnswer" : true
  }, {
    "content" : "choice-2",
    "isAnswer" : false
  } ],
  "score" : 5.0,
  "isGradable" : true,
  "isActive" : true
}

{
  "status" : "success",
  "data" : {
    "id" : 1
  }
}

단답형 문제를 생성하기 위한 API입니다.

HTTP Method : POST
End-Point   : /api/admin/problems/short

POST /api/admin/problems/short HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Authorization: Bearer TEST-TOKEN
Content-Length: 162
Host: localhost:8080

{
  "title" : "test",
  "description" : "test",
  "tags" : [ "db", "network" ],
  "answer" : "test",
  "score" : 5.0,
  "isGradable" : true,
  "isActive" : true
}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 57

{
  "status" : "success",
  "data" : {
    "id" : 1
  }
}

{
  "title" : "test",
  "description" : "test",
  "tags" : [ "db", "network" ],
  "answer" : "test",
  "score" : 5.0,
  "isGradable" : true,
  "isActive" : true
}

{
  "status" : "success",
  "data" : {
    "id" : 1
  }
}

단답형 문제 단건 조회를 위한 API입니다.

HTTP Method : GET
End-Point   : /api/admin/problems/short/{problem_id:Long}

GET /api/admin/problems/short/1 HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Authorization: Bearer TEST-TOKEN
Host: localhost:8080

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 231

{
  "status" : "success",
  "data" : {
    "id" : 1,
    "title" : "test",
    "description" : "test",
    "tags" : [ "db", "network" ],
    "answer" : "test",
    "score" : 5.0,
    "isActive" : true,
    "isGradable" : true
  }
}

{
  "status" : "success",
  "data" : {
    "id" : 1,
    "title" : "test",
    "description" : "test",
    "tags" : [ "db", "network" ],
    "answer" : "test",
    "score" : 5.0,
    "isActive" : true,
    "isGradable" : true
  }
}

단답형 문제 검색을 위한 API입니다.

HTTP Method : GET
End-Point   : /api/admin/problems/short
Req Params  : id, title, description page, size

GET /api/admin/problems/short?title=test&description=t&size=5&page=1 HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Authorization: Bearer TEST-TOKEN
Host: localhost:8080

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 267

{
  "status" : "success",
  "data" : {
    "problems" : [ {
      "id" : 1,
      "title" : "title",
      "creator" : "creator",
      "answerRate" : 1.0,
      "userAnswerCnt" : 1,
      "isActive" : true
    } ],
    "totalPages" : 1,
    "totalElements" : 1
  }
}

{
  "status" : "success",
  "data" : {
    "problems" : [ {
      "id" : 1,
      "title" : "title",
      "creator" : "creator",
      "answerRate" : 1.0,
      "userAnswerCnt" : 1,
      "isActive" : true
    } ],
    "totalPages" : 1,
    "totalElements" : 1
  }
}

단답형 문제 수정를 위한 API입니다.

HTTP Method : PUT
End-Point   : /api/admin/problems/short/{problem_id:Long}

PUT /api/admin/problems/short/1 HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Authorization: Bearer TEST-TOKEN
Content-Length: 164
Host: localhost:8080

{
  "title" : "test1",
  "description" : "test1",
  "tags" : [ "db", "network" ],
  "answer" : "test",
  "score" : 5.0,
  "isGradable" : true,
  "isActive" : true
}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 57

{
  "status" : "success",
  "data" : {
    "id" : 1
  }
}

{
  "title" : "test1",
  "description" : "test1",
  "tags" : [ "db", "network" ],
  "answer" : "test",
  "score" : 5.0,
  "isGradable" : true,
  "isActive" : true
}

{
  "status" : "success",
  "data" : {
    "id" : 1
  }
}

문제 삭제를 위한 API입니다.

HTTP Method : DELETE
End-Point   : /api/admin/problems/{problem_id:Long}

DELETE /api/admin/problems/1 HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Authorization: Bearer TEST-TOKEN
Host: localhost:8080

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 43

{
  "status" : "success",
  "data" : true
}

{
  "status" : "success",
  "data" : true
}

여러 개의 문제 삭제를 위한 API입니다.

HTTP Method : DELETE
End-Point   : /api/admin/problems

DELETE /api/admin/problems HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Authorization: Bearer TEST-TOKEN
Content-Length: 25
Host: localhost:8080

{
  "ids" : [ 1, 2, 3 ]
}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 43

{
  "status" : "success",
  "data" : true
}

{
  "ids" : [ 1, 2, 3 ]
}

{
  "status" : "success",
  "data" : true
}

ADMIN 유저 조회를 위한 API입니다.

HTTP Method : GET
End-Point   : /api/admin/users/admin

GET /api/admin/users/admin HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Authorization: Bearer TEST-TOKEN
Host: localhost:8080

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 124

{
  "status" : "success",
  "data" : [ {
    "id" : "66b95f70-b7fc-4b82-bbd4-df734bf3da85",
    "username" : "email"
  } ]
}

{
  "status" : "success",
  "data" : [ {
    "id" : "66b95f70-b7fc-4b82-bbd4-df734bf3da85",
    "username" : "email"
  } ]
}

Notification 단일 생성을 위한 API입니다.

HTTP Method : POST
End-Point   : /api/admin/notification

POST /api/admin/notification HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Authorization: Bearer TEST-TOKEN
Content-Length: 110
Host: localhost:8080

{
  "content" : "알림이 왓어요",
  "userId" : "aec0b6cc-f670-43dd-aeff-1c8b0ccd603d",
  "link" : "url"
}

{
  "content" : "알림이 왓어요",
  "userId" : "aec0b6cc-f670-43dd-aeff-1c8b0ccd603d",
  "link" : "url"
}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 57

{
  "status" : "success",
  "data" : {
    "id" : 1
  }
}

{
  "status" : "success",
  "data" : {
    "id" : 1
  }
}

Notification 다중 생성을 위한 API입니다.

HTTP Method : POST
End-Point   : /api/admin/notifications

POST /api/admin/notifications HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Authorization: Bearer TEST-TOKEN
Content-Length: 140
Host: localhost:8080

{
  "content" : [ {
    "content" : "알림이 왔어요",
    "userId" : "ccbcf6b3-103b-4fff-89dc-ad98ef735c72",
    "link" : "url"
  } ]
}

{
  "content" : [ {
    "content" : "알림이 왔어요",
    "userId" : "ccbcf6b3-103b-4fff-89dc-ad98ef735c72",
    "link" : "url"
  } ]
}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 59

{
  "status" : "success",
  "data" : {
    "size" : 1
  }
}

{
  "status" : "success",
  "data" : {
    "size" : 1
  }
}

Notification 삭제를 위한 API입니다.
단일 삭제는 List에 ID 한 개만 넣어서 요청하시면 됩니다.

HTTP Method : DELETE
End-Point   : /api/admin/notification

문제 세트 생성을 위한 API입니다.

HTTP Method : POST
End-Point   : /api/admin/problem-sets

POST /api/admin/problem-sets HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Authorization: Bearer TEST-TOKEN
Content-Length: 81
Host: localhost:8080

{
  "problemIds" : [ 1, 2 ],
  "name" : "name",
  "description" : "description"
}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 40

{
  "status" : "success",
  "data" : 1
}

{
  "problemIds" : [ 1, 2 ],
  "name" : "name",
  "description" : "description"
}

{
  "status" : "success",
  "data" : 1
}

문제 세트 수정을 위한 API입니다.

HTTP Method : POST
End-Point   : /api/admin/problem-sets/{problem_set_id}

PUT /api/admin/problem-sets/1 HTTP/1.1
Content-Type: application/json
Content-Type: application/json
Accept: application/json
Authorization: Bearer TEST-TOKEN
Content-Length: 81
Host: localhost:8080

{
  "problemIds" : [ 1, 2 ],
  "name" : "name",
  "description" : "description"
}

{
  "problemIds" : [ 1, 2 ],
  "name" : "name",
  "description" : "description"
}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 40

{
  "status" : "success",
  "data" : 1
}

{
  "status" : "success",
  "data" : 1
}