프로젝트에서 API 명세서와 ERD 설계를 맡았다. API 명세서를 작성해본 적이 없어서 최대한 공식적인 자료를 바탕으로 찾아보다가 사막의 오아시스같은 글을 발견해서 정리하고 두고두고 보려고 한다. 이번 프로젝트에서 활용을 당연히 하겠지만 앞으로도 정말 큰 도움이 될 것같다..😍 API는 '서버와 클라이언트가 데이터를 주고 받을 수 있도록 도움을 주는 매개체'이다.API 명세서는 서버와 클라이언트간 특정 기술을 사용하기 위한 약속이다. API 문서화에 들어가야할 내용1) 개요기술 문서의 서론은 독자들에게 본문의 요약, 작성 배경, 관련 개념을 설명해준다. 즉, 독자들을 위한 '가이드'이다. API 문서에도 서론의 역할을 하는 개요(Overview)가 필요하다. API 소개단순히 API에 대한 기능 설명..

REST/Restful API란? REST 아키텍처 스타일의 디자인 원칙을 준수하는 API다. REST 디자인 원칙 균일한 인터페이스 클라이언트-서버 Stateless 캐싱 가능성 코드 온디맨드 HTTP URI를 통해 자원(resource)을 명시 해당 자원에 대해 HTTP 메소드를 활용해서 CRUD 기능을 수행 HOW TO UNDERSTAND API REST REST/RESTful API 에 대한 이해가 기반되어야 한다. Interface(상호의 얼굴 😃) (사전상) 컴퓨터 프로그램이 user와 주고받는 정보를 나타내는 방법 메뉴/스크린의 레이아웃 GUI(Graphical User Interface): 사용자가 편리하게 사용할 수 있도록 컴퓨터의 어떠한 기능을 아이콘 따위로 나타낸 것 (결론) 어떤 두..