728x90 API2 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. REST API REST API란? REST API는 웹에서 사용되는 데이터나 자원(Resource)을 HTTP URI로 표현하고, HTTP 프로토콜을 통해 요청과 응답을 정의하는 방식을 말한다. 웹 애플리케이션에서는 HTTP 메서드를 이용해 서버와 통신한다. GET을 통해 웹 페이지나 데이터를 요청하고, POST로 새로운 글이나 데이터를 전송하거나 DELETE로 저장된 글이나 데이터를 삭제할 수 있다. 이처럼 클라이언트와 서버가 HTTP 통신을 할 때는 어떤 요청을 보내고 받는냐에 따라 메서드의 사용이 달라진다. 클라이언트와 서버 사이에도 데이터와 리소스를 요청하고 요청에 따른 응답을 전달하기 위한 메뉴판이 필요하다. 이 메뉴판을 보고 클라이언트는 식당에서 식사를 주문하듯 서버에 요청하고, 이에 대한 응답을 메뉴판에 .. 2023. 5. 23. 이전 1 다음 728x90
