mat_ai
22
2021-03-12 14:17:32 작성 2021-03-12 14:18:56 수정됨
2
113

DB/API 설계시 문서화 사용하는 도구 추천해주실만한거 있으실까요?


백엔드 서버를 개발할 때 가장 기본적으로 데이버테이스 모델링을 하고, API 설계를 하게 될텐데요

요즘 트렌드나 기술적으로 뛰어나신 분들께서는 주로 어떻게 문서화하고 공유하고 계신지 궁금합니다. :)

매번 만난 팀/사람마다 도구가 매번 다르다 보니까 사실 업계에서 딱 정해진 도구가 있는거 같지는 않습니다만, 그래도 다양하게 쓰신 경험이 있으신 분들 중에서 어떨때는 뭐가 좋았고 어떨때는 뭐가 좋았다 이런 조언을 들어보고 싶습니다!


저는 API 설계의 경우에는 약간 힙한? 환경에서는 Swagger를  썼었는데, 그 외에는 거의 그냥 워드 프로세서 (구글 독스, 스프레드 시트) 를 활용해서 공유를 했던거 같습니다.

데이터베이스 모델링은 최대한 이쁘게 제가 구태여 나서서 할 때는 UML 툴등을 썼었습니다만, 이것도 역시 실제 현업에서 협업할 때는 그냥 워드 프로세서를 쓰게 되더라구요.

사실 워드 프로세서 (여기서는 구글 독스) 를 쓰는 이유가 뭔가 특별한 걸 더 학습하거나 설치할 필요가 없이 인터넷이 되는 모든 사람이 접근할 수 있어서인거 같기는 한데, 사실 뭔가를 설치/학습하더라도 그 비용만큼 더 가치 있는 도구를 얻게 된다면 충분히 시도해볼만한 거 같기는 합니다.

다른 분들은 어떤 것들을 써보시고 뭐가 비용 대비 가치가 괜찮았다 이런것들 알려주시면 감사하겠습니다 :)

0
  • 답변 2

  • 배고파서서러워요
    2k
    2021-03-12 16:45:04

    swagger 썼었는데요... 비개발자들이 보기 싫어해서 그냥 Excel이나 워드로 정리해서 줍니다(....)

    postman으로 api목록 json파일로 같이 던져주면 좋아하더라고요(....)

  • mat_ai
    22
    2021-03-16 10:06:27

    @배고파서서러워요

    흠... 확실히 그런 이슈 (비개발자는 swagger 별로 안좋아함) 가 어디서나 있긴 하네요.

    엑셀, 워드가 뭔가 찝찝하고 짜증나긴 해도 (수정사항 지속반영이 특히..)
    앞으로도 계속 그렇게 하긴 해야겠네요

  • 로그인을 하시면 답변을 등록할 수 있습니다.