728x90 Swagger1 API 문서화(Documentation) / Spring Rest Docs API 문서화(Documentation) API 문서화는 애플리케이션 프로그래밍 인터페이스(API)를 개발자들이 쉽게 이해하고 사용할 수 있도록 설명하고 문서화하는 과정입니다. 이는 개발자들이 API를 올바르게 활용하고 문제를 해결하는데 도움이 되며, 개발 프로세스에서 매우 중요한 부분입니다. 백엔드 애플리케이션, REST API 방식의 애플리케이션에서 의미하는 API 문서화란 클라이언트가 REST API 백엔드 애플리케이션에 요청을 전송하기 위해서 알아야 되는 요청 정보(요청 URL(또는 URI), request body, query parmeter 등)를 문서로 잘 정리한 것을 의미합니다. 이렇게 작성된 API 문서는 API의 기능과 목적을 간략하게 설명하여 개발자가 API의 사용 시나리오를 파악할 .. 2023. 7. 3. 이전 1 다음 728x90