Restdoc Swagger Ui Sample
서론
-
개발에서 테스트 코드의 중요성에 대해서는 따로 포스팅 예정입니다.
-
백엔드에서 api 개발시 해당 api의 사용법에 대한 문서화는 협업에서 필수입니다.
-
가장 무식한 방법으로는 confluence가 되었든 wiki가 되었든, 엑셀이 되었든 api 개발이 있을때 마다 수작업으로 문서화하는 방법이 있는데 api가 수정될 때마다 문서를 수정해줘야 하는 단점이 있습니다. 깜빡하고 문서 업데이트가 안되는 케이스가 현업에서 얼마나 자주 발생하는 지를 생각하면 절대 비추.
-
기존에 swagger 를 사용할 수도 있으나, 테스트 코드를 강제하지 않는 다는 점에서 제 경우 rest doc을 선호합니다. 테스트 코드를 작성하지 않으면 개발자로 인정할 수 없다고 생각할 정도로 TDD 신봉자라서 더더욱 그렇네요.
그런데 말입니다.
- restdoc 을 사용하여 테스트 코드를 작성하고, 문서 자동화 하는 거. 다 좋습니다.
- 그런데 restdoc 으로 생성된 문서를 브라우저에서 제대로 띄우려면 asciidoc 문법을 또 따로 익혀야 합니다. (https://asciidoc.org/)
- ascii doc의 문법을 또 익히느라 시간을 보내기는 싫으시죠?
- 방법이 있습니다.
- ui 부분만 따로 swagger-ui 로 만들 수 있습니다.
예제 코드
https://github.com/Pink-Spider/restdoc-swagger-ui-example