API 정의서 프로그램 보통 뭐 쓰시나요?

Question

요즘 회사 에서 옛날 API 정의서를 최신화 하는 중 입니다.이전 개발자가 만들어 놓고 최신화도 안하고 던져 놓은거 수정하느라 눈알이 빠질거 같은데DOCX 로 만들어 놓아서 테이블 고치는게 어렵습니다…공공 기관 하청 할때는 필수 한글 해서 그때도 힘들었는데..후API 문서 프로그램 다른 분들은 뭐 쓰시나요?

곰같은개발자 · Answer

만약 자바 같은 경우에는 swagger나 spring docs 설정해서 해당 페이지 복사해서 붙여 넣거나 파이썬으로 json 형태 데이터 받아서 엑셀로 변환해서.. 문서에 맞게 복북 하게 되네요.. 그리고 요즘에 apidog 라고 있는데 이것도 나름 괜찬은것 같아요. 프리티어로 어느정도 엑셀이나 pdf로 내보내기도 가능하구요.이외에는 머.. 갈아 넣어서 크흠[.. ]

이브레인소프트 · Answer

사견입니다.apidog (문서도구는 아니지만..) : postman 대체제로 고려할만한 가치 있음. 사용하기 편하고, 문서 배포가 용이함. swagger : 별도로 문서 관리에 소모할 시간이 줄어듦. 단, annotation 이 많아져서 Controller 가 너저분해(?) 지는..restdoc : 최초 문서 템플릿 예쁘게(?) 만드는 시간과 Test Code 작성이 살짝 피곤함.

HJOW · Answer

별도 유료프로그램 도입이 어렵다 해도docx 보다는 보통 xlsx 로 만들지 않나요?아마 그 워드 파일도, 원래는 엑셀로 만들었다가 붙여넣은 결과물이 아닐지…

kimhwanhoon · Answer

Redoc 추천해요

API 정의서 프로그램 보통 뭐 쓰시나요?

4개의 답변

기타 목록