Syncope.T-*
Springboot OpenAPI 3, springdoc-openapi의 사용기 上
BackEnd/Spring 2022. 10. 5. 08:55

필요성의 자각 Spring 프로젝트를 백엔드 용도로 진행하면 API 문서를 작성해야만 한다. 대학에서 그렇게 논문을 쳐다보던 사람이 개발자가 되서는 문서의 효율성을 모르는 사람마냥 여기는 사람이 많더라. API 문서는 사용자의 입장에서 최대한 질문이 없도록 꼼꼼하게 써야하고, 필요한 내용이 있으면 업데이트를 해야만 한다. 프로젝트를 추후에나 혹은 새 인원이 참가하는 경우에도 인수인계를 최소한으로 할 수 있을만큼 작성되어야 한다는 것. 그리고 API 문서는 개발 진행 당시에도 중요하지만 최종 산출물이기도 하다. 좋은 API가 무엇인가를 좀 더 알고 싶다면, LINE 형님들이 쓴 글을 읽어보면 도움이 된다. 그 동안에는 어떻게 쓰였는가? 1) 문서 프로그램으로 작성 초기에는 심한경우는 Excel(물론 정리되..

profile on loading

Loading...