ping 엔드포인트 구현하기

▶ ping 엔드포인트(endpoint) 구현

엔드포인트 : API 서버가 제공하는 통신 채널 혹은 접점

프론트엔드 서버의 클라이언트가 백엔드 API 서버와 통신할 때 엔드포인트에 접속하는 형태로 통신

각 엔드포인트는 고유의 URL 주소를 가지게 되며, 고유의 URL 주소를 통해 엔드포인트에 접속

 

각 엔드포인트는 고유의 기능을 담당 → 이러한 엔드포인트들이 모여 하나의 API 구축

ex) SNS 서비스를 위한 API : 사용자 sign up 엔드포인트, 사용자 로그인 엔드포인트, 새로운 포스팅 생성 엔드포인트, 다른 사용자들과 친구 맺기 엔드 포인트 등 여러 엔드포인트로 구성

 

ping endpoint - "pong"이라는 텍스트를 return하는 endpoint

- 아주 간단한 엔드포인트지만 실제 시스템에서 사용될 수 있는 엔드 포인트

- API 서버가 현재 운행되고 있는지 아니면 정지된 상태인지를 간단하게 확인할 때 사용

- 헬스 체크(health check) 엔드 포인트라고도 함

- API 서버에 접속하지 않고 해당 API의 정상 운행 여부를 간단하게 체크하는 엔드 포인트

 

1. API 코드가 위치할 디렉터리 생성

mkdir -p ~/Projects/api

- 디렉터리 이름은 api로 지정, 그러나 실제 디렉터리 이름은 다른 이름으로 지어도 상관 없음

- (-p)옵션은 디렉터리의 중간 경로에 해당하는 디렉터리가 이미 존재하지 않으면 자동으로 생성하라는 뜻

 

다음 방법을 사용하였는데, 명령 구문이 옳지 않다고 하는 경우

mkdir  "C:\Users\SUZY/Projects/api" 와 같이 절대 경로를 사용하여도 무방

 

 

ping 엔드 포인트 구현하는 것부터는 다음 포스팅에서!

참고하는 책 : "Do it! 점프 투 플라스크", "깔끔한 파이썬 탄탄한 백엔드"