API 문서 만드는거 질문 드립니당

Question

안녕하세요.병원에서 일하는 웹 개발자 신입입니다.저희 병원이 좀 큰 병원인데, 병원에 다양한 건강관련 문진들을 전부 한 프로젝트에서 다루고 있습니다.이게 그래서 프로그램이 꽤 큰데, 옛날에 누가 단신으로 만든거라서 관련 문서화 작업은 하나도 안되어있고 그냥 코드만 달랑 있습니다.이거 수정해야 해서 제가 맡게 되었는데내용 익히는 김에 제가 API 문서같은 것들 만들어두면 나중에 찾아보기 편할 거 같아서만들려고 합니다.API 내용 정리나, 요청부터 응답까지 어떤 클래스들을 거치게 되고, 어떤 데이터가 이동되는 지 등을 정리하려고 하는데,스웨거 같은거를 쓰면 한번에 처리가 가능한가용?다들 보통 어떻게 하시는 지 궁금합니당

장독깨기 · Answer

한 번에 처리 안 됩니다. ㅎ요청부터 응답까지 어떤 클래스들을 거치게 되고 => 이건 sequence 다이어그램을 이용해보시구요,어떤 데이터가 이동되는 지 => 이건 DFD 한 번 알아보세요.이 외에도 UML 을 알아보면 클래스다이어그램 등 다양한 방법이 있습니다.API 명세는 저 같은 경우 그냥 엑셀파일로 정리하는데요, 편한걸로 하면 될 거 같습니다.

개발잡부 · Answer

api명세서는 노션 추천 https://www.notion.com/ko/templates/api-reference

더미 · Answer

스웨거 써도 님이 안 써놓으면 안 해줍니다.

API 문서 만드는거 질문 드립니당

3개의 답변

Q&A 목록