개요
API를 문서화 시키는 것은 상당히 중요한 작업입니다. 여러 API들을 개발했다 하더라도 문서화가 되어있지 않거나 제대로 작성되지 않았더라면 API를 사용하는 이점이 줄어들 뿐만 아니라 제대로 사용하기 불가능하기 때문에 이러한 API들을 잘 작성하는 것에도 꽤 시간을 투자해야 합니다.
이러한 불편함과 어려움들을 많이 줄여주는 API 문서자동화 도구(프로젝트 파일에 형식을 지켜 작성해놓으면 이를 바탕으로 자동생성함) 시키면 자동으로 가 있는데 그것을 swagger라고 합니다
간단한 설정으로 프로젝트에서 지정한 URL들을 HTML 화면으로 확인할 수 있게 해주는 프로젝트입니다. Swagger를 활용해서 API 명세를 작성한다면, 보다 쉽게 API 명세를 작성할 수 있습니다. https://overcome-the-limits.tistory.com/101
[협업] 협업을 위한 swagger 설정하기 (feat node.js)
들어가며 스타트업에서 서버 개발자로 일하면서, 불편한 점을 하나씩 해결하고자 노력하고 있습니다. 그중, 하나가 API 명세서 작성에 관한 부분이었습니다. 처음 팀에 합류하고 API 개발을 위해
overcome-the-limits.tistory.com
이러한 작업을 통해 서버개발자와 효율적인 소통을 가능하게 하고 문서작업을 하는 시간이 줄어들게 됩니다.
https://github.com/bjc1102/swagger-test
Node Express - Swagger 연동
이번에 node express와 swagger를 이용해 api서버와 docs를 만들어야할 일이 생겼다.좀 찾아보니 npm에 swagger라는 라이브러리를 많이들 사용하는 것 같았다. 테스트겸 설치 후 docs를 읽으려보니, 마지막
velog.io
'TIL > 개념정리' 카테고리의 다른 글
| DB 트랜잭션에 대해서 (0) | 2022.07.27 |
|---|---|
| Nginx와 apache가 무엇인지 (0) | 2022.07.21 |
| API 쉽게 이해하기 (0) | 2022.07.19 |
| Framer-motion 간단한 사용법 정리 (0) | 2022.07.16 |
| @keyframes - animation 사용법 (0) | 2022.07.14 |