문서화 툴 openapi3 + Stoplight 적용하기

배경(아래 글에서는 openapi3 에 대해서는 다루지 않습니다. 관련 내용은 다른 블로그를 참고하시길 바랍니다.) 현재 API 문서는 openapi3 + Swagger-ui 조합의 자동화툴로 문서를 만들어왔습니다.클라이언트 분들에게 가장 익숙한 툴이고 서버에 바로 API를 보내볼 수 있는 기능도 있어서 적절한 툴이라고 생각했었습니다.하지만 Swagger-UI를 사용하면서 몇 가지 단점을 느끼게 되었고 이러한 단점을 개선한 다른 툴로 문서를 바꿔보려고 합니다. 어떤 단점이 있었는가?개요의 부재Swagger-UI는 리스트형식으로 API를 문서화하고 있습니다.만약 유저에 관한 API를 보고 있는 중, 달리기에 관한 API를 보고 싶다면 기존에 보고 있던 유저 API를 접은 뒤, 달리기 API를 스크롤을 내..
개발 스토리 2025. 7. 15. 17:59
1