RestAPI Integration

[yuujinleee]

📓 유진이의 노트

yujin_restapi branch 에서 현재 작업 중 ...

완료사항 ✅

• 장르조합별 영화 개수 엑셀파일 올려놓음 (scripts/movie_num_per_genre.xlsx)

• pom.xml , gitignore 수정

  • jacoco code coverage test minimum 0%로 바꿔놓음

• milestone 2 junit 테스트는 현재 주석처리 (너무 오래걸려서..)

• RestAPI 초기 세팅 완료

• PART 1

  • json 데이터 받아서 파싱 (parsing) 처리, 톰캣 서버 세팅에서 고치고 RestController? api 주고받는거 http 고침.
  • 인풋 아웃풋 json 처리 + formatting 완료
  • curl 커맨드 문제 처리 완료 (Requestbody - json 받기)
    • 왜 Argument 4개일 때 결과값이 이상하게 나오지.. ("" "" "" "Action" 인데 다른 장르 나옴) -> 해결. 아래 참고.
  • 에러 핸들링? (= Invalid 인풋 서버단에서 자르기. 이딱딱.)

• PART 2

  • 기본적인 모델 오브젝트 + 컨트롤러
  • 컨트롤러 자바에 맞게 수정 + 영준 코드 받아서 붙이기.
  • 에러핸들링

---

현재 진행 중 ❗❗❗❗❗❗

1순위

• Part 1 완료

• Part 2완료

• junit testing

  • jacoco code coverage 90%로 올리고 junit test 작성

• Readme 작성

그 외 점검 사항 (안 중요)

• 서버 세팅
  • 서버 실행 커맨드 ( ./mvnw spring-boot:run ) run.sh 에 포함?
• Bean 처리 해야하나.. (서버 개발 시 변수이름이 안보여서 태그 달아주는 용도..?)
• genres? or genre? ( 현재 모두 genre. )

• maven dependancy 에서 org.json 안쓰이면 삭제하기 (삭제완료)

  Notes

  • 현재 사용중인 버전 정보
• Spring boot : 2.0.2.RELEASE
• Spring-core / spring-beans : 5.0.6.RELEASE
• Tomcat (서버) : 8.5.31
  • 특수문자(파이프라인) 처리 때문에 8.0.30 쓰고 싶었는데 conflict 해소가 안됌.
• jackson (json 처리 라이브러리) : 2.12.0
• 그 외

    <java.version>11</java.version>
    <maven.compiler.version>3.8.1</maven.compiler.version>
    <maven.compiler.source>1.8</maven.compiler.source>
    <maven.compiler.target>1.8</maven.compiler.target>
    <junit-jupiter.version>5.2.0</junit-jupiter.version>
    <junit-platform.version>1.2.0</junit-platform.version>
    <jacoco.version>0.8.2</jacoco.version>

  • Spring boot 버전 2.4.5 가 Junit 5 (Junit Jupiter)와 호환이 잘 안되는 듯. (아래 참고2 링크) 현재 pom.xml 에는 2.0.2.RELEASE 버전. 만약 상위 버전이랑 JUnit 5랑 호환 되면 업글하겟슴. <- 불가능

[yuujinleee]

Useful links for RESTapi development 🔗

내가 자주 쓰는 거

Postman (sw) - GET test 쉽게 하기

1. Instantly parse JSON into any language - https://app.quicktype.io/

2. URL decoder/encoder - https://meyerweb.com/eric/tools/dencoder/

   Helpful Documentations

   코드 짜면서 봤던 거 중 중요한 링크들

3. Instruction 에 있는 링크

A good reference to get familiar with Spring and REST APIs can be found at https://spring.io/guides/gs/rest-service and https://spring.io/guides/tutorials/rest/.

2. Spring Boot 2 && Junit 5 (Jupiter) 셋업

스프링 부트 2에서 JUnit 5를 사용하는 방법을 정리한다. 먼저 pom.xml 파일을 다음과 같이 수정한다.

• spring-boot-starter-test 의존 설정에서 junit:junit을 제외 처리
• junit-jupiter-api 의존 추가
• maven-surefire-plugin 플러그인 JUnit 5 기준 설정. 주의할 점은 maven-sufire-plugin의 버전을 2.19.1로 설정해야 한다는 점이다. 스프링 부트 2.0.2는 maven-surefire-plugin의 2.21.0 버전을 기본으로 사용하는데 이 버전은 JUnit 5를 제대로 처리하지 못한다.

3. RESTful API 설계 가이드

4. The Spring @Controller and @RestController Annotations https://www.baeldung.com/spring-controller-vs-restcontroller @RestController 는 @Controller and @ResponseBody 두 개 합쳐져 있는 annotation. 더 편리.

5. Spring @RequestParam Annotation 사용법 https://www.baeldung.com/spring-request-param

   // required value 지정 <- Required String parameter '인자' is not present error 방지 ?
   // Parameter 값을 받아올 때 null이거나 Type이 맞지 않는 경우 400 에러 발생
   @GetMapping("/api/foos")
   @ResponseBody
   public String getFoos(@RequestParam(required = false) String id) { 
   return "ID: " + id;
   }
   // 디폴트 value
   @RequestParam(defaultValue = "test") String id

6. Serialization & Deserialization 관련 library 비교 (Jackson vs. Gson vs. JSON-B vs. JSON-P vs. org.JSON vs. Jsonpath)

   Json (string) -> Object : Serialization //// Object -> Json (string) : Deserialization 나는 아래 자료 참조해서 jackson 으로 사용 중

Maven dependancy - com.fasterxml.jackson.core https://itsallbinary.com/jackson-vs-gson-vs-json-b-vs-json-p-vs-org-json-vs-jsonpath-java-json-libraries-features-comparison/

7. JSON array export examples How to create a JSON array using Jackson - https://attacomsian.com/blog/jackson-create-json-array jackson-databind - https://github.com/FasterXML/jackson-databind/#get-it

8. URL encode issue

   //X
   GET /spring-mvc-basics-4/products/get2?product={"id": 1,"name": "Asus Zenbook","price": 800}
   //O
   GET /spring-mvc-basics-4/products/get2?product=%7B%22id%22%3A%201%2C%22name%22%3A%20%22Asus%20Zenbook%22%2C%22price%22%3A%20800%7D

9. etc The following guides illustrate how to use some features concretely: Building a RESTful Web Service Serving Web Content with Spring MVC Building REST services with Spring

[yuujinleee]

1) To Run spring-boot ,
(in your local)

yujinlee@Yujins-MacBook-Pro CSE364_Project % ./mvnw spring-boot:run

2) To Build maven && Run spring-boot at the same time,

yujinlee@Yujins-MacBook-Pro CSE364_Project % mvn clean install spring-boot:run -e

[yuujinleee]

RestAPI 관련 Piazza 답변 모음

1. To process www form url, you need to use @RequestParam annotation instead of @RequestBody. In this milestone, please ignore www form URL input type. So, it won't be wrong even though you get 400 error in a browser. 
2. limit parameter
   • limit parameter optional and integer type. That is, if limit is given from input, the program must take it as an integer. If it is not given at all, then the program takes as a default number 10. Changed BB accordingly. 
   • Given the size of our dataset (3883 movies, 6040 users, and 1000209 ratings), your program should support at least top 700, which is approximately 20% of total movies assuming that the ratings between 1 and 5 are evenly distributed.
3. "genres" or "genre" ? we won't deduct points for using "genre".

[yuujinleee]

milestone2.java 오류 해결

• 같은 리스트 반복해서 나오는 문제 포함

  public class milestone2 {
  // Object
  private static ArrayList<Classified_by_vote> classified_table = null;
  
  // Setter
  public static ArrayList<Classified_by_vote> make_classified_table(ArrayList<Movie_data_node> movie_rating_matrix, double C, int m) throws IOException{
      ArrayList<Classified_by_vote> classified_table = new ArrayList<>();
      ~~~
      milestone2.classified_table = classified_table; //여기 라인이 중요, setter 역할 함
      return classified_table;
   }
  // Getter    
  public String get_classified_table(int index){
  ~~~
  }

[yuujinleee]

README 작성용 / 이것저것

카카오 로그인 REST API - https://developers.kakao.com/docs/latest/ko/kakaologin/rest-api

URL

GET /oauth/authorize?client_id={REST_API_KEY}&redirect_uri={REDIRECT_URI}&response_type=code HTTP/1.1
Host: kauth.kakao.com

[yuujinleee]

https://pjh3749.tistory.com/273

Error handling

성공/실패에 대한 HTTP Status Code 를 클라이언트로 보내주면서 해당 메시지도 같이 보내주면 될 것 같네요. Spring을 사용하신다면 @ControllerAdvice를 이용한 Exception Handling을 하시면 될 것 같습니다. 해당 핸들러는 ResponseEntityExceptionHandler 를 상속받아 사용하시면 될 거에요.

HTTP 상태 코드

100-level (정보): 서버가 요청을 알아 들었습니다. 200-level(성공): 서버가 요청을 예상한대로 완료했습니다. 300-level(리다이렉션): 요청을 완료하려면 클라이언트의 추가작업이 필요합니다. 400-level(클라이언트 에러): 클라이언트가 유효하지않은 요청을 했습니다. 500-level(서버 에러): 서버가 서버 에러 때문에 유효한 요청을 수행하지 못했습니다.

에러 핸들링

에러를 처리하는 가장 간단한 방법은 적절한 응답 코드를 내려주는 것입니다.

자주 나오는 응답 코드들은 다음과 같습니다.

400 Bad Request - 클라이언트가 유효하지 않은 요청을 보낸 경우 (request body나 파라미터를 빼먹은 경우같이) 401 Unauthorized - 해당 서버에 클라이언트 인증이 실패한 경우 403 Forbidden - 클라이언트가 인증은 됐지만 요청한 자원에 대한 권한은 없는 경우 (예를 들어 로그인된 사용자가 관리자 페이지에 접근하는 경우 겠죠?) 404 Not Found - 요청한 자원이 존재하지 않는 경우 412 Precondition Failed - Request Header 필드 중 한 개 이상의 값이 잘못 된 경우 500 Internal Server Error - 서버에서 발생된 일반적인 에러 503 Service Unavailable - 요청된 서비스가 이용가능하지 않는 경우

[1] https://www.baeldung.com/exception-handling-for-rest-with-spring [2] 오류 시 메시지 커스터마이징 http://www.baeldung.com/global-error-handler-in-a-spring-rest-api

[yuujinleee]

클라이언트단 데이터 오류 => 400

[yuujinleee]

Part 1 Error Handling

// format
{
    "error": "InputInvalidError",
    "message": [
        "Entered gender input (ABCD) is invalid.",
        " Entered age input (EFG) is invalid.",
        " Entered occupation input (HIJK) is invalid.",
        " Entered genre input (LMN|OP) is invalid."
    ]
}

1 - requestbody 쪽 error handling

occupation 이 없거나 || 다른 벨류 끼어들어와도 디폴트 자바인풋 "" "" "" 로 실행

2 ~ 6 - (아래 사진 참조)

• Milestone2랑 다른 점은,
  • 기존 6(장르)에서 "Acccction|Adventure"로 오류났을 시 메세지 내에 전체 인풋스트링 포함됌 (2말고 1리턴) 1 Entered gender input (Acccction|Adventure) is invalid. 2 Entered gender input (Acccction) is invalid.

1개 오류

여러개 오류

7 - 처리할 필요 X. (args 3개인 케이스로 fall) 8~9 - 처리할 필요 X. 애초에 해당하는 인풋 set이 없는 데 혹시 모를 fallback 때문에 넣었던 오류라.

[yuujinleee]

Movie (Part2 / Milestone3.java) 에러 경우

1. args.length가 1또는 2가 아니면 에러 서버에서 무조건 String [2] 로 java에 보내줌 args.length 1인 경우 입력은 -> "Toy Story" "10" (디폴트) 로 보내줌.

2. limit 입력이 0이거나 숫자가 아닐때 에러 - check_age_validity 서버처리필요

3. Title이 제대로 입력 안되면 에러 - check_title_validity 서버처리필요 Title 이 공백일 경우 -> 안 돼!

4. NoDB Error - 일어날 일 X

2, 3 만 처리하면 됌 .. ?

• limit 이 너무 클 때는 ?

---

Toy Story (1995) 가능 ToyStory(1995) 가능 toy stoRy (1995) 가능 Toy Story 불가능

[yuujinleee]

Movie error 처리 예시

Valid

Invalid title

Invalid limit (-5, 0 둘다 아래로 나옴)

둘 다 Invalid

[yuujinleee]

영화 평가 수가 20개 이상이면 if문 아니면 else문