210317_TIL

* 어제의 다짐

- Spring Docs 문서화하기

=> @AutoConfigureRestDocs가 제대로 되지 않았던 문제를 해결하고 상품에 대한 문서화 완료

 

*오늘 한 일

- Describe-Context-It 때문에 @AutoConfigureRestDocs가 되지 않아 제거하였습니다. 기존에 있던 테스트코드 방식 작성 때문에 문서화 어노테이션이 제대로 작동하지 않았습니다. 오류 메세지를 보았지만 원인에 대한 해결책도 잘 나오지 않아서 수정하는데 오랜 시간이 걸렸습니다. 작은 프로젝트였기 때문에 앞으로는 원인이 예상되는 곳을 잘 예측하고 빠르게 확인하도록 하겠습니다.

 

- 테스트에 document 코드를 추가했습니다. http 요청, 응답 부분에 필드명(parameterWith), 타입(type). 설명(description) 3가지를 알 수 있도록 했습니다. 이 관례는 우아한 형제들 블로그를 참고했습니다. 상품에 대한 리팩토링을 했기 때문에 이제 사용자에 대한 리팩토링을 하면 됩니다.

 

-snippet를 활용하여 asciidocs를 작성했습니다. 상품의 필드명, 타입, 설명이 담긴 요청, 응답 필드 snippet, http 요청, 응답 snippet, 요청 파라미터 snippet을 활용했습니다. 그래서 가장 많게는 총 5개의 snippet을 이용하였고(update) 적게는 2개의 snippet을 이용하였습니다.(lists)

 

*내일 할 일

- 사용자에 대한 snippet 작성하기

- docker 배포 간단하게 작업하기