Kotudy API 명세

POST /api/v1/member HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Length: 63
Host: localhost:8080

{
  "username" : "Hong-Gildong",
  "password" : "password"
}

HTTP/1.1 201 Created
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Location: http://localhost:8080/api/v1/member/1
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 362

{
  "msg" : "회원 가입이 완료되었습니다.",
  "id" : 1,
  "username" : "Hong-Gildong",
  "password" : "password",
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/api/v1/member",
      "type" : "POST"
    },
    "login" : {
      "href" : "http://localhost:8080/api/v1/member/login",
      "type" : "POST"
    }
  }
}

POST /api/v1/member/login HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Length: 63
Host: localhost:8080

{
  "username" : "Hong-Gildong",
  "password" : "password"
}

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 136

{
  "msg" : "로그인이 완료되었습니다.",
  "accessToken" : "eyJhbGciOiJIUzI1NiJ9.eyJ1c2VybmNhQ5uHZELuMKK_1O_Wcd9lx0aggkg"
}

GET /api/v1/member/1 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Length: 63
Host: localhost:8080

{
  "username" : "Hong-Gildong",
  "password" : "password"
}

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 269

{
  "msg" : "검색한 회원의 정보는 다음과 같습니다.",
  "id" : 1,
  "username" : "Hong-Gildong",
  "memberMyWordList" : [ ],
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/api/v1/member/1",
      "type" : "GET"
    }
  }
}

GET /api/v1/dictionary/word?q=%EC%82%AC%EB%9E%91 HTTP/1.1
Host: localhost:8080

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 734

{
  "msg" : "표준 한국어 대사전 Open API를 통해 단어 하늘의 검색결과는 다음과 같습니다.",
  "datum" : [ {
    "targetCode" : 20311,
    "word" : "하늘",
    "pronunciation" : "하늘",
    "pos" : "명사",
    "wordSenceList" : [ {
      "senseOrder" : 1,
      "definition" : "땅 위로 펼쳐진 무한히 넓은 공간."
    }, {
      "senseOrder" : 2,
      "definition" : "절대적인 존재, 하느님."
    } ]
  } ],
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/api/v1/dictionary/word?q=%EC%82%AC%EB%9E%91",
      "type" : "GET"
    },
    "add-myWord" : {
      "href" : "http://localhost:8080/api/v1/myWord",
      "type" : "POST"
    }
  }
}

POST /api/v1/myWord HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJ1c2VybmNhQ5uHZELuMKK_1O_Wcd9lx0aggkg
Content-Length: 73
Host: localhost:8080

{
  "name" : "단어",
  "morpheme" : "품사",
  "mean" : "의미"
}

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 548

{
  "msg" : "단어이름 단어 추가가 성공하였습니다.",
  "data" : {
    "wordId" : 1,
    "name" : "단어",
    "morpheme" : "품사",
    "mean" : "의미"
  },
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/api/v1/myWord",
      "type" : "POST"
    },
    "delete-myWord" : {
      "href" : "http://localhost:8080/api/v1/myWord/1",
      "type" : "DELETE"
    },
    "search-myWord" : {
      "href" : "http://localhost:8080/api/v1/myWord?page=0&count=10",
      "type" : "GET"
    }
  }
}

DELETE /api/v1/myWord/1 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJ1c2VybmNhQ5uHZELuMKK_1O_Wcd9lx0aggkg
Host: localhost:8080

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 432

{
  "msg" : "1번의 단어 삭제를 성공하였습니다.",
  "data" : {
    "wordId" : 1,
    "name" : "단어",
    "morpheme" : "품사",
    "mean" : "의미"
  },
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/api/v1/myWord/1",
      "type" : "DELETE"
    },
    "search-myWord" : {
      "href" : "http://localhost:8080/api/v1/myWord?page=0&count=10",
      "type" : "GET"
    }
  }
}

GET /api/v1/myWord?page=0&count=10 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJ1c2VybmNhQ5uHZELuMKK_1O_Wcd9lx0aggkg
Content-Length: 41
Host: localhost:8080

{
  "name" : "2",
  "morpheme" : "2"
}

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 670

{
  "msg" : "나만의 단어 검색 결과는 다음과 같습니다.",
  "datum" : {
    "content" : [ {
      "wordId" : 1,
      "name" : "단어",
      "morpheme" : "품사",
      "mean" : "의미"
    } ],
    "pageable" : "INSTANCE",
    "totalElements" : 1,
    "last" : true,
    "totalPages" : 1,
    "size" : 1,
    "number" : 0,
    "sort" : {
      "empty" : true,
      "sorted" : false,
      "unsorted" : true
    },
    "first" : true,
    "numberOfElements" : 1,
    "empty" : false
  },
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/api/v1/myWord?page=0&count=10",
      "type" : "GET"
    }
  }
}

GET /api/v1/quiz HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: localhost:8080

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 1623

{
  "msg" : "나만의 단어장을 기반으로 생성된 퀴즈입니다.",
  "datum" : [ {
    "question" : "의미4",
    "answerIndex" : 1,
    "choices" : [ "단어4", "단어5", "단어6", "단어7" ]
  }, {
    "question" : "의미8",
    "answerIndex" : 1,
    "choices" : [ "단어8", "단어9", "단어10", "단어11" ]
  }, {
    "question" : "의미12",
    "answerIndex" : 1,
    "choices" : [ "단어12", "단어13", "단어14", "단어15" ]
  }, {
    "question" : "의미16",
    "answerIndex" : 1,
    "choices" : [ "단어16", "단어17", "단어18", "단어19" ]
  }, {
    "question" : "의미20",
    "answerIndex" : 1,
    "choices" : [ "단어20", "단어21", "단어22", "단어23" ]
  }, {
    "question" : "의미24",
    "answerIndex" : 1,
    "choices" : [ "단어24", "단어25", "단어26", "단어27" ]
  }, {
    "question" : "의미28",
    "answerIndex" : 1,
    "choices" : [ "단어28", "단어29", "단어30", "단어31" ]
  }, {
    "question" : "의미32",
    "answerIndex" : 1,
    "choices" : [ "단어32", "단어33", "단어34", "단어35" ]
  }, {
    "question" : "의미36",
    "answerIndex" : 1,
    "choices" : [ "단어36", "단어37", "단어38", "단어39" ]
  }, {
    "question" : "의미40",
    "answerIndex" : 1,
    "choices" : [ "단어40", "단어41", "단어42", "단어43" ]
  } ],
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/api/v1/quiz",
      "type" : "GET"
    },
    "apply-quiz-result" : {
      "href" : "http://localhost:8080/api/v1/quiz",
      "type" : "PATCH"
    }
  }
}

PATCH /api/v1/quiz HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJ1c2VybmNhQ5uHZELuMKK_1O_Wcd9lx0aggkg
Content-Length: 19
Host: localhost:8080

{
  "score" : 5
}

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 332

{
  "msg" : "퀴즈 결과가 반영되었습니다.",
  "ranking" : 1,
  "score" : 5,
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/api/v1/quiz",
      "type" : "PATCH"
    },
    "get-quiz-ranking" : {
      "href" : "http://localhost:8080/api/v1/quiz/ranking",
      "type" : "GET"
    }
  }
}

GET /api/v1/quiz/ranking/nonMember HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: localhost:8080

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 526

{
  "msg" : "퀴즈 랭킹 결과입니다.",
  "topMemberRanking" : [ {
    "ranking" : 1,
    "username" : "1번 사람",
    "score" : 9
  }, {
    "ranking" : 2,
    "username" : "2번 사람",
    "score" : 8
  }, {
    "ranking" : 3,
    "username" : "3번 사람",
    "score" : 7
  }, {
    "ranking" : 4,
    "username" : "4번 사람",
    "score" : 6
  } ],
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/api/v1/quiz/ranking/nonMember",
      "type" : "GET"
    }
  }
}

GET /api/v1/quiz/ranking HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJ1c2VybmNhQ5uHZELuMKK_1O_Wcd9lx0aggkg
Host: localhost:8080

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/hal+json;charset=UTF-8
Content-Length: 589

{
  "msg" : "퀴즈 랭킹 결과입니다.",
  "userRanking" : 1,
  "username" : "1번 사람",
  "userScore" : 9,
  "topMemberRanking" : [ {
    "ranking" : 1,
    "username" : "1번 사람",
    "score" : 9
  }, {
    "ranking" : 2,
    "username" : "2번 사람",
    "score" : 8
  }, {
    "ranking" : 3,
    "username" : "3번 사람",
    "score" : 7
  }, {
    "ranking" : 4,
    "username" : "4번 사람",
    "score" : 6
  } ],
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/api/v1/quiz/ranking",
      "type" : "GET"
    }
  }
}

GET /api/v1/todayWord HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/json
Host: localhost:8080

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json;charset=UTF-8
Content-Length: 497

{
  "msg" : "오늘의 단어 목록입니다.",
  "datum" : [ {
    "name" : "1번 단어",
    "morpheme" : "1번 품사",
    "mean" : "1번 의미"
  }, {
    "name" : "2번 단어",
    "morpheme" : "2번 품사",
    "mean" : "2번 의미"
  } ],
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/api/v1/todayWord",
      "type" : "GET"
    },
    "add-myWord" : {
      "href" : "http://localhost:8080/api/v1/myWord",
      "type" : "POST"
    }
  }
}