본문 바로가기

SWAGGER2

API 명세서 작성 tip https://tech.kakaoenterprise.com/127 [TW] API 문서 톺아보기시작하며 안녕하세요. 카카오엔터프라이즈 테크니컬라이팅 팀의 Crystal(김유리), Sandy(차신영), July(김정인)입니다. 테크니컬라이팅 팀에서는 Kakao i 기술문서 사이트에 카카오엔터프라이즈가 개tech.kakaoenterprise.com정말 정말 좋은 글이다! 꼭 한 번씩 읽어보자 https://cobinding.tistory.com/165 [BackEnd] API 명세서 작성 가이드 라인 | 작성 예시프로젝트에서 API 명세서와 ERD 설계를 맡았다. API 명세서를 작성해본 적이 없어서 최대한 공식적인 자료를 바탕으로 찾아보다가 사막의 오아시스같은 글을 발견해서 정리하고 두고두고 보려고 cob.. 2024. 10. 6.
엔드포인트(Endpoint)에 대해서 엔드포인트(Endpoint)는 특히 API 개발 및 네트워크 통신에서 중요한 개념이다. 본 글에서는 엔드포인트의 정의, 역할, 종류, 그리고 엔드포인트를 효과적으로 관리하는 방법에 대해 자세히 설명하고자 한다.  ㅇ엔드포인트(Endpoint): 시스템 간의 통신에서 데이터가 주고받는 최종 지점즉, 클라이언트와 서버 간의 상호작용이 이루어지는 접점이다. 엔드포인트는 주로 API의 URL로 표현되며, 특정 기능이나 자원에 접근하기 위한 주소로 사용된다.예를 들어, https://api.example.com/users라는 URL은 사용자 정보를 다루는 엔드포인트이다. 클라이언트는 이 엔드포인트를 통해 사용자 데이터를 요청하거나 전송할 수가 있다.  [엔드포인트 역할]데이터 교환의 창구: 클라이언트는 엔드포인트.. 2024. 10. 5.