문서화1 [Spring] RestAssured, RestDocs로 API 문서 자동화 하기 with 공식문서 API 명세서는 애플리케이션의 동작, 소통을 위해 빠질 수 없는 부분이다. API 명세서(문서)를 통해 API의 기능, 사용방법, 제한사항 등을 명확하게 이해할 수 있다.여러 작업자가 함께 일한다면(ex. 프론트엔드 - 백엔드) API 문서를 통해 API를 올바르게 호출하고 필요한 데이터를 교환할 수 있다.제대로된 명세서가 있다면 빠른 소통이 가능해진다.그러나, 기능이 추가/변경될 때 API 명세서도 지속적으로 업데이트 되지 않는다면 제대로 된 소통이 어려워진다. 실제로 지금 구현하던 애플리케이션에서도 수정이 생겼을 때마다 명세서를 수정하다가, 어느순간 기능 구현만 신경쓰고 문서화를 놓치게 되었다. 그래서 문서화를 수동으로 작성하기 보다는 자동화하는 것이 낫겠다는 생각을 했다. 문서 자동화를 할 수 있는.. 2024. 6. 9. 이전 1 다음
