반응형
필요 라이브러리 설치
Flask를 사용하기 위해서는 아래의 라이브러리를 설치해주어야 한다.
pip install flask flask-restfulFlask 서버 실행하기
플라스크 서버를 실행하는 방법은 간단하다.
말그대로 인스턴스를 생성(포스팅에서는 'app'이라 정의)하고, 실행(run)을 해주면 된다.
### app.py ###
from flask import Flask
# Flask 인스턴스 생성
app = Flask(__name__)
# 메인 함수일 경우에만 Flask 서버 실행
if __name__ == '__main__' :
app.run()API 통신을 위한 URL 설정 및 기능 정의
API의 통신 방식 절차를 알아보자.
- API 서버와 통신할 주소(URL)로 요청을 한다.
- 서버 내에서 요청에 대한 작업을 수행한다.
- 작업 결과를 클라이언트(요청자)에게 반환한다.
즉, Flask에서 클라이언트가 접근할 수 있는 URL을 지정해주어야 API 통신이 가능하다는 의미이다.
# 'GET' 부분은 HTTP 메소드를 넣는다.
@app.route('/', methods=['GET'])
def func() : # 수행될 함수를 선언한다.
# 해당 URL 주소에 수행할 기능을 정의한다.
### 수행 코드 작성 ####
return 'value' # 요청에 대한 반환될 결과를 정의한다.- @app.route('/', methods=['GET']
- route('/') : 해당 경로로 이동하여 methods의 기능을 수행
- route(methods=['GET']) : 지정한 경로의 데이터를 가져옴
기본 루트를 '/'로 지정하였으므로, 로컬을 기준으로 요청을 수행하는 경로는 127.0.0.1:포트번호 이다.
- [참고] Flask의 기본 포트는 5000번이다.
Hello World 출력하기
위의 내용을 참고하여 간단히 HelloWorld 를 반환하는 Flask API 서버를 생성해보자.
소스 코드 작성 (app.py)
# app.py
from flask import Flask
# API 서버를 구축하기 위한 기본 구조
app = Flask(__name__)
# API는 함수로 처리
@app.route('/', methods=['GET'])
def hello_world() :
return 'Hello World!'
if __name__ == '__main__' :
app.run()실행
- 터미널에서 실행
python app.py서버 작동 확인
아래와 같이 메시지가 나온다면 정상적으로 서버가 작동된거다.
- Running on http://127.0.0.1:5000 확인
API 테스트
웹 브라우저를 실행하여 지정한 경로로 이동해보자.
그리고 Hello World가 정상적으로 출력되는지 확인해보자.
API 테스트 유틸리티
API 테스트는 주로 포스트맨(Postman) 프로그램을 사용하는 것이 편하다.
포스트맨 사용법에 대해서는 아래의 포스팅을 참고하길 바란다.
반응형