app.py파일이 실행파일이고 resources폴더안에 recipe.py와 recipe_info.py파일이 들어있다.
mysql_connection.py파일에는 mysql에 연결하기위한 코드들이 작성되어 있다.
app.py 코드
from flask import Flask
from flask_restful import Api
from resources.recipe import RecipeListResource
from resources.recipe_info import RecipeResource
app = Flask(__name__)
api = Api(app)
# 경로와 리소스(API 코드)를 연결한다.
api.add_resource(RecipeListResource, '/recipes')
api.add_resource(RecipeResource, '/recipes/<int:recipe_id>')
if __name__ == "__main__":
app.run()플라스크를 import하고 기본 구조 작성뒤 경로와 리소스를 연결한다.
recipe.py 코드
from http import HTTPStatus
from flask import request
from flask_restful import Resource
from mysql.connector.errors import Error
from mysql_connection import get_connection
import mysql.connector
### API 를 만들기 위한 클래스 작성
### class(클래스) 란?? 변수와 함수로 구성된 묶음!
### 클래스는 상속이 가능하다!
### API를 만들기 위한 클래스는, flask_restful 라이브러리의
### Resource 클래스를 상속해서 만들어야 한다.
class RecipeListResource(Resource):
# restful api 의 method 에 해당하는 함수 작성
def post(self) :
# api 실행 코드를 여기에 작성
# 클라이언트에서, body 부분에 작성한 json 을
# 받아오는 코드
data = request.get_json()
# 받아온 데이터를 디비 저장하면 된다.
try :
# 데이터 insert
# 1. DB에 연결
connection = get_connection()
# 2. 쿼리문 만들기
query = '''insert into recipe
(name, description, cook_time, directions)
values
( %s , %s , %s ,%s);'''
record = (data['name'], data['description'], data['cook_time'], data['directions'] )
# 3. 커서를 가져온다.
cursor = connection.cursor()
# 4. 쿼리문을 커서를 이용해서 실행한다.
cursor.execute(query, record)
# 5. 커넥션을 커밋해줘야 한다 => 디비에 영구적으로 반영하라는 뜻
connection.commit()
# 6. 자원 해제
cursor.close()
connection.close()
except mysql.connector.Error as e :
print(e)
cursor.close()
connection.close()
return {"error" : str(e)}, 503
return {"result" : "success"}, 200
def get(self) :
# 쿼리 스트링으로 오는 데이터는 아래처럼 처리해준다.
offset = request.args.get('offset')
limit = request.args.get('limit')
# 디비로부터 데이터를 받아서, 클라이언트에 보내준다.
try :
connection = get_connection()
query = '''select *
from recipe
limit '''+offset+''' , '''+limit+''';'''
# select 문은, dictionary = True 를 해준다.
cursor = connection.cursor(dictionary = True)
cursor.execute(query)
# select 문은, 아래 함수를 이용해서, 데이터를 가져온다.
result_list = cursor.fetchall()
print(result_list)
# 중요! 디비에서 가져온 timestamp 는
# 파이썬의 datetime 으로 자동 변경된다.
# 문제는! 이데이터를 json 으로 바로 보낼수 없으므로,
# 문자열로 바꿔서 다시 저장해서 보낸다.
i = 0
for record in result_list :
result_list[i]['created_at'] = record['created_at'].isoformat()
result_list[i]['updated_at'] = record['updated_at'].isoformat()
i = i + 1
cursor.close()
connection.close()
except mysql.connector.Error as e :
print(e)
cursor.close()
connection.close()
return {"error" : str(e)}, 503
return { "result" : "success" ,
"count" : len(result_list) ,
"result_list" : result_list }, 200insert와 select가 post, get 메소드로 구현되어있다.
recipe_info.py 코드
from http import HTTPStatus
from flask import request
from flask_restful import Resource
from mysql.connector.errors import Error
from mysql_connection import get_connection
import mysql.connector
class RecipeResource(Resource):
# 클라이언트로부터 /recipes/3 이런식으로 경로를 처리하므로
# 숫자는 바뀌므로, 변수로 처리해준다.
def get(self, recipe_id):
# 디비에서, recipe_id에 들어있는 값에 해당되는
# 데이터를 select 해온다.
try :
connection = get_connection()
query = '''select *
from recipe
where id = %s;'''
record = (recipe_id, )
# select 문은, dictionary = True 를 해준다.
cursor = connection.cursor(dictionary = True)
cursor.execute(query, record)
# select 문은, 아래 함수를 이용해서, 데이터를 가져온다.
result_list = cursor.fetchall()
print(result_list)
# 중요! 디비에서 가져온 timestamp 는
# 파이썬의 datetime 으로 자동 변경된다.
# 문제는! 이데이터를 json 으로 바로 보낼수 없으므로,
# 문자열로 바꿔서 다시 저장해서 보낸다.
i = 0
for record in result_list :
result_list[i]['created_at'] = record['created_at'].isoformat()
result_list[i]['updated_at'] = record['updated_at'].isoformat()
i = i + 1
cursor.close()
connection.close()
except mysql.connector.Error as e :
print(e)
cursor.close()
connection.close()
return {"error" : str(e)}, 503
return {'result':'success',
'info':result_list[0]}
# 데이터를 업데이트하는 API들은 put 함수를 사용한다.
def put(self, recipe_id):
# body에서 전달된 데이터를 처리
data = request.get_json()
# 디비 업데이트 실행코드
try:
# 데이터 업데이트
# 1. DB에 연결
connection = get_connection()
# 2. 쿼리문 만들기
query = '''update recipe
set name = %s, description = %s,
cook_time = %s,
directions = %s
where id = %s;'''
record = (data['name'], data['description'], data['cook_time'], data['directions'], recipe_id)
# 3. 커서를 가져온다.
cursor = connection.cursor()
# 4. 쿼리문을 커서를 이용해서 실행한다.
cursor.execute(query, record)
# 5. 커넥션을 커밋해줘야 한다 => 디비에 영구적으로 반영하라는 뜻
connection.commit()
# 6. 자원 해제
cursor.close()
connection.close()
except mysql.connector.Error as e:
print(e)
cursor.close()
connection.close()
return {'error':str(e)}, 503
return {'result':'sucess'}, 200
# 삭제하는 delete 함수
def delete(self, recipe_id):
try:
# 데이터 삭제
# 1. DB에 연결
connection = get_connection()
# 2. 쿼리문 만들기
query = '''delete from recipe
where id = %s;'''
record = (recipe_id, )
# 3. 커서를 가져온다.
cursor = connection.cursor()
# 4. 쿼리문을 커서를 이용해서 실행한다.
cursor.execute(query, record)
# 5. 커넥션을 커밋해줘야 한다 => 디비에 영구적으로 반영하라는 뜻
connection.commit()
# 6. 자원 해제
cursor.close()
connection.close()
except mysql.connector.Error as e:
print(e)
cursor.close()
connection.close()
return {'error':str(e)}, 503
return {'result':'success'}, 200select, update, delete가 get, put, delete 메소드로 구현되어 있다.
'REST API' 카테고리의 다른 글
| Flask에서 로그인한 유저만 처리할 수 있는 API에 토큰 적용하는 방법 (0) | 2022.06.20 |
|---|---|
| Flask 회원가입/로그인 API에서, 토큰 생성해서 처리하는 방법 (0) | 2022.06.20 |
| Flask에서 JWT 설치방법 (0) | 2022.06.20 |
| 포스트맨 사용법 (0) | 2022.06.17 |
| restful api란 (0) | 2022.06.17 |
