728x90 백엔드3 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. 관계형 데이터 베이스 - SQL 데이터베이스란? 전자적으로 저장되고 체계적인 데이터 집합이다. 여기에는 단어, 숫자, 이미지, 비디오 및 파일을 포함한 모든 유형의 데이터가 포함될 수 있다. DBMS (데이터베이스 관리 시스템) 라는 소프트웨어를 사용하여 데이터를 저장, 검색 및 편집할 수 있다. 데이터베이스의 필요성 1. In-Memory Java에서 데이터를 다룰 때에는 프로그램이 실행될 때에만 존재하는 데이터가 있다. Java에서 변수를 만들어 저장한 경우, 프로그램이 종료될 때 해당 프로그램이 사용하던 데이터도 사라진다. 이 말은 변수 등에 저장한 데이터가 프로그램의 실행에 의존한다는 말이다. 예기치 못한 상황으로부터 데이터를 보호할 수 없고, 프로그램이 종료된 상태라면 데이터를 원하는 시간에 받아올 수 없으며, 데이터의 수명이.. 2023. 5. 24. 코드 스테이츠 4/12 - 웹 웹 클라이언트와 웹 서버 클라이언트(client, 손님)와 서버(server, 서빙하는 사람)라는 단어의 어원을 떠올리며 생각하면 더 쉽다. 클라이언트와 서버는 요청과 응답을 주고 받는 관계이다. 클라이언트는 서버에 요청을 하고 서버는 클라이언트에 응답을 내려주는 방식으로 진행된다. 요청을 하지도 않았는데 응답이 오는 경우는 없다. 좀 더 쉽게 이해하기 위해 카페를 대입해보자 클라이언트는 손님이 되고 서버는 점원이 된다. 손님은 아메리카노(리소스)를 획득하기 위해 아메리카노(리소스)를 가지고 있는 점원에게 요청을 하게 된다. 손님의 요청에 따라 점원은 아메리카노(리소스)를 담아 응답한다. 이처럼 클라이언트에서 서버에 요청을 하고, 서버는 클라이언트의 요청에 응답하여 클라이언트에 리소스를 내려주는 것이 클.. 2023. 4. 12. 이전 1 다음 728x90
