Python Flask를 사용한 REST API서버 개발방법

API 서버 개발과정은 크게

화면기획서 > DB 테이블 설계 > API 서버 개발의 과정으로 이루어진다.

 

그 중 마지막 과정인, Python의 Flask 프레임워크를 사용한 REST API 서버 개발 방법에 대해 알아보자.

 

from flask import Flask
from flask_restful import Api

app = Flask(__name__)

api = Api(app)

# api.add_resource(클래스명, 경로)
# api.add_resource(RecipeListResource, '/recipes')
# api.add_resource(RecipeResource, '/recipes/<int:recipe_id>')
# api.add_resource(RecipePublishResource, '/recipes/<int:recipe_id>/publish')


if __name__ == '__main__':
    app.run()

메인파일인 app.py의 뼈대는 다음과 같이 만든다.

그리고 주석 처리한 api.add_resource 부분에 내가 만든 API 리소스를 하나씩 추가해주면 된다.

add_resource는 API 경로와 밑에서 만든 클래스를 연결하는 역할을 한다.

 

 

API 리소스는 아래와 같이 따로 파일을 만들어 작성하는데,

flask_restful의 Resource 클래스를 상속해서 만든다.

 

 

flask를 기본 실행하는 방법은 아래와 같다.

# cmd 창에서
flask run

# 또는
python app.py

# flask 실행 명령어
flask run --help

 

실행됐을 때의 커맨드 창

 

주소로 접속해보면 현재는 뼈대만 있기 때문에 404 Not Found가 뜬다.

 

리소스를 개발한 뒤 테스트는 Postman 툴을 이용해서 한다.