텍스트 블록
과 Record
의 등장을 이유로 서비스 구현이 훨씬 용이할 것이라 판단하였다.Swagger와 RestDocs의 장단점은 아래와 같다.
Swagger | RestDocs | |
---|---|---|
장점 | 어노테이션 기반으로, 문서화 과정이 간편하다. | 테스트 코드가 통과해야만 문서화가 된다. |
때문에 API의 안전성을 보장할 수 있다. | ||
만들어진 문서를 통해 실제로 API를 실행시킬 수 있다. | 프로덕션 코드에 문서화를 위한 코드를 작성할 필요가 없다. | |
단점 | 테스트 코드의 성공 여부 상관없이 문서가 작성되어, API의 안전성을 보장할 수 없다. (→ API 문서를 통해서 우리가 잘못된 API를 확인해야 하는 것이 아니지 않을까?) | 문서화 과정이 번거롭다. |
프로덕션 코드에 문서화를 위한 코드를 작성해야 한다. 프로덕션 코드가 복잡해 보일 수 있다. | 실제 API를 작동시켜서 확인해 볼 수 없다. |
아래와 같은 이유로 swagger
를 선택했다.
단점 보완
RDBMS를 선택하는 이유
MySQL을 선택하는 이유