Change Directory

Author: hwanld

.idea/.gitignore

@@ -0,0 +1,17 @@
+# Spring REST Docs vs Swagger
+## Spring REST Docs
+* 장점
+    * 테스트 기반 API 명세서 자동화이기 때문에, `테스트 코드를 통과한 검증된 API 문서`(검증이 되지 않을 경우, Test Failed)
+    * main 소스 코드의 가독성을 해치지 않는다.
+* 단점
+    * `적용이 어렵다` (러닝커브가 높다)
+    * 반드시 TDD를 적용해야 하고, `명세화 하고 싶은 모든 API의 테스트 코드를 작성`해야 한다. (테스트가 선행되지 않으면 작성할 수 없다)
+
+## Swagger
+* 장점
+    * 몇 개의 어노테이션 만으로 API 문서를 작성할 수 있디. (비교적 `난이도가 낮다`)
+    * Swagger 에서 제공하는 `웹페이지에서 API 테스트가 가능`하다.
+* 단점
+    * main 소스 코드의 가독성을 해친다.
+    * 어노테이션에 의해서 동작하기 때문에, 올바르지 않는 정보가 제공될 수 있다.
+