Java/Spring 기반의 Restful API 문서 자동화 및 설명하기 좋은 솔루션


iOS Native + WebApp 개발을 하고 있습니다. Android 도 병행하게 될 것 같군요. 그런데 서버 Rest API의 각 항목에 대한 설명이 없고, API사용에 대한 가이드가 없이 작업을 하는데,매번 작업할 때마다 말로 물어봐야 하는 상황입니다. 그런데 물리적인 거리가 있어서 좀 불편한 상황이 많은 것 같아요 Java/Spring 기반인데 Rest API 문서화 관련한 좋은 플랫폼이나 사례가 있을까요? 현재는 swagger 를 사용하고 있긴합니다만.. API URL과 파라미터만 있어서 눈치껏 해야하는 상황입니다..

  • 2016년 07월 27일에 작성됨
    iOS / 安卓 / 前端工程

조회수 344


1 답변


좋아요
2
싫어요
채택취소하기

swagger 에도 주석 설명을 달 수 있습니다. 저는 서버개발자에게 URL 별로 기획서 페이지번호와 이름을 주석으로 간단히 적어달라했었어요.

궁금한점이나 요청사항은 구글 독스 스프레드 시트 하나 만들어서 서로 연락하면 했었어요.

엑셀로하니 채팅보다 어떤항목이 처리됬는지 아닌지 편하더라구요.

서버개발자분이 조금 귀찮아지는 작업이지만 의사소통비용도 말그대로 비용이니깐요이미지

  • 2016년 07월 27일에 작성됨

  • 이쪽 개발자는 Description 을 쓰지 않아서 문제군요..ㅋㅋ. 사람이문제네요..ㅠㅠ    Xu   2016.7.27 11:41     
  • 말로 물어보는거보다 한 번 적는게 훠월씬 편합니다. 잘 얘기해보세여    최봉재   2016.7.27 12:00     

로그인이 필요한 기능입니다.

Hashcode는 개발자들을 위한 무료 QnA사이트 입니다. 작성한 답변에 다른 개발자들이 댓글을 작성하거나 좋아요/싫어요를 할 수 있기 때문에 계정을 필요로 합니다.
► 로그인
► 계정만들기
Close