🧑🏻‍💻시니어개발자🧑🏻‍💻

#6. Python으로 API 개발(데이타베이스 모델 작업)

이전 포스팅에 데이타베이스 모델링 작업을 했고, 여기서는  server.py에 flask_restful에서 제공되는

API Resource을 추가해 보자.

⌘ server.py ( 위치: linkservice/server/server.py)

----------------------------------------------------------------------------------------------------------

기존 server.py 에 추가해보자.

import socket
from config.create_app import create_app
from flask import Flask
    #flask_restful에서 API와  src 밑에 links.py에 class들을 import 한다.
from flask_restful import Api
from src.links import LinkRegister, LinksAll, LinkSelect, LinkRemove, LinkUpdate
from db_init import db

env = socket.gethostbyname(socket.gethostname())
if 'linkservice.com' in env :
   app = create_app('production')
else:
   app = create_app('development')
# print(app.config)
    # API 선언
api = Api(app)
    #API에 Resource를 추가한다.
api.add_resource(LinkRegister, '/api/link/create')
api.add_resource(LinksAll, '/api/links')
api.add_resource(LinkSelect, '/api/link/select/<int:id>')
api.add_resource(LinkRemove, '/api/link/delete/<int:id>')
api.add_resource(LinkUpdate, '/api/link/update/<int:id>')

if __name__ == "__main__":
# ORM
    db.init_app(app)
    app.run(debug=True, port=5000)

저장 후 이제 실행해서 확인해보자.

⎮실행방법

   1.     터미널에서 가상화 실행 ( source ./bin/activate )

   2.     python3 server.py 실행

   3.     POSTMAN에서 API 테스트

실행후 POSTMAN에서 테스트를 해보자.

1.1.  API 테스트

☑︎ POST /api/link/create - 링크정보 등록

          Body에 JSON으로 데이터를 넣고 진행해보자.

message을 정상적으로 return 받는지 확인한다.

☑︎ GET /api/links – 전체 링크정보 조회

☑︎ GET /api/link/select/<int:id>        - ID에 해당한 링크정보조회

☑︎ PUT /api/link/update/<int:id>           - name을 수정해보자.

☑︎ DELETE /api/link/delete/<int:id> - ID에 해당한 링크정보 삭제

LINKS 테이블에 대한 CRUD API가 완성되었다.

주요 테이블인 LINKS의 CRUD API가 완성되었으므로, 프론트엔드에서 실제 화면을 구현을 해보고, 아직까지 DB및 API설계에 빠진 것은 화면을 개발하면서 추가적으로 제작해 보기로 한다.

#5. Python으로 API 개발(기본환경구성)

Python Flask의 기본환경이 구성되었고, 이젠 데이터베이스 관련 작업을 진행한다.

SQLAlchemy는 Python에서 사용가능한 ORM(Object-Relational Mapping) 이며, 객체와 관계형 데이터베이스의 데이터를 자동으로 매핑(연결)해주는 것을 말한다.

여기서는 Flask에서 확장형태로 SQLALchemy을 지원하는 Flask-SQLALchemy 라이브러리를 사용한다.

⌘ db_init.py ( 위치: linkservice/server/db_init.py)

---------------------------------------------------------------------------------------------------------

db_init.py는 db = SQLAlchemy() 선언을 해주는 공통 모듈로 활용 한다.

from flask_sqlalchemy import SQLAlchemy
db = SQLAlchemy()

⌘ links_model.py ( 위치: linkservice/server/models/links_model.py)

---------------------------------------------------------------------------------------------------

이제부터 links 테이블에 대한 DB모델을 제작하고, 기본적인 id 값으로 삭제/조회/업데이트 등 필요한 기본 METHOD을 정의한다.

from db_init import db
from sqlalchemy import func

class LinkModel(db.Model):
	# DB 스키마가 기본(public)이 아니면 별도로 선언을 해주면 된다.
    __table_args__ = {'schema': 'aip'}
    
	# 물리 테이블명
    __tablename__ = "links"
    
	# 컬럼 맵핑
    
    id = db.Column(db.Integer, primary_key=True)
    name = db.Column(db.String(100))
    tag = db.Column(db.String(50))
    sort = db.Column(db.Integer)
    imageurl = db.Column(db.Text)
    linkurl = db.Column(db.Text)
    create_date = db.Column(db.Date)
    update_date = db.Column(db.Date)

    def __init__(self, id, name, tag, sort, imageurl, linkurl, create_date,update_date):
        self.id = id
        self.name = name
        self.tag = tag
        self.sort = sort
        self.imageurl = imageurl
        self.linkurl = linkurl
        self.create_date = create_date
        self.update_date = update_date

    def save(links):
        """
        정보 저장    :param 정보 객체
        """
        db.session.merge(links)
        db.session.commit()
        db.session.close()

	# Link정보 저장시 sort 순서의 max값을 구한다. 만약 null이면 0 으로 변경
    # 화면에 출력되는 순서를 변경하기 sort항목이 필요하며, 링크정보 등록시 max값을 저장하기위해서 필요
    
    @classmethod
    def max_sort(self):
      result = db.session.query(func.coalesce(func.max(self.sort), 0)).scalar()

      return result+1

	# 기본적인 조회/삭제/업데이트 코드를 구성한다. ( param : id )
    
    @classmethod
    # id로 조회
    def find_by_id(self, id):
		links= db.session.query(self).filter_by(id=id).first()
        return links

    @classmethod
    # id로 삭제    
    def delete_by_id(self, id):
		try:
        	db.session.query(self).filter_by(id=id).delete(synchronize_session=False)
      	except:
        	db.session.rollback()
      	finally:
        	db.session.commit()
        	db.session.close()

    @classmethod
    # id로 values값을 업데이트
    def update_by_id(self, id, values):
        db.session.query(self).filter_by(id=id).update(values)     
        db.session.commit()   
        db.session.close()     

    def __str__(self):
        return "[" + str(self.__class__) + "]: " + str(self.__dict__)

Links 테이블의 DB모델과 기본 정보 조회/삭제/업데이트 관련 메서드도 제작이 끝났으니,

이젠 API 형태로 제공하고자 Resource를 제작한다. 

1.1. Resource 제작

⌘ links.py ( 위치: linkservice/server/src/links.py)

---------------------------------------------------------------------------------------------------

links.py에서 API 호출 시 실행되는 class을 정의해보자.

-       class LinkRegister(Resource) : 링크정보를 DB에 등록(Insert) 한다.

-       class LinksAll(Resource) : 전체 링크 정보를 조회한다.

-       class LinkSelect(Resource) : 선택한 링크정보를 조회한다..

-       class LinkRemove(Resource) : 선택한 링크정보를 삭제한다..

-       class LinkUpdate(Resource) : 선택한 링크정보를 수정한다..

from db_init import db
from flask_restful import Resource, reqparse
from flask import jsonify, request
from flask_marshmallow import Marshmallow
from models.links_model import LinkModel
from datetime import date as date_function

ma = Marshmallow() #객체를 Python 데이터 유형으로 직렬화

class LinkSchema(ma.SQLAlchemyAutoSchema):
    class Meta:
        model = LinkModel

"""
POST /api/link/create -  등록 resource
"""
class LinkRegister(Resource):
# 입력 파라미터 설정
# DB항목에 맞게 파라메타로 받아 저장한다.
    parser = reqparse.RequestParser()
    parser.add_argument('name',type=str,required=True,help="필수항목입니다.")
    parser.add_argument('tag',type=str)
    parser.add_argument('sort',type=str)     
    parser.add_argument('imageurl',type=str )      
    parser.add_argument('linkurl',type=str )    

    def post(self):
        # Request Parameter를 dictionary 형태로 저장
        data = LinkRegister.parser.parse_args()
        name = data['name']
        tag = data['tag']
        sort = LinkModel.max_sort() #Sort순서를 위한 값으로 입력시 max값을 입력한다.
        imageurl = data['imageurl']
        linkurl = data['linkurl']
        create_date = date_function.today()  #create_date는 datetime으로 저장
        update_date = date_function.today()

        LinkModel.save(LinkModel(None, name, tag, sort, imageurl, linkurl, create_date, update_date))

        return {'message':f'링크 정보가 등록 되었습니다'},201

"""
GET /api/links - 전체 링크정보 조회
"""

class LinksAll(Resource):

    def get(self):
    # 입력 파라미터 설정 - 목록전체 출력으로 파라미터가 없음.
        link = LinkModel.query.order_by(LinkModel.sort).all()
        link_schema = LinkSchema(many=True)
        output = link_schema.dump(link)
        return jsonify({'links' : output})

"""
GET /api/link/select/<int:id> - 링크 정보 조회
"""
class LinkSelect(Resource):

    def get(self,id):
        # 정보 조회
        link = LinkModel.find_by_id(id)
        link_schema = LinkSchema()
        output = link_schema.dump(link)
        return jsonify({'links' : output})

"""
DELETE /api/link/delete/<int:id> - 링크정보삭제
"""
class LinkRemove(Resource):
    def delete(self, id):
        # 정보 삭제 ( links_model의 delete_by_id 메소드 호출 )
        LinkModel.delete_by_id(id)

        return {'message':'정상적으로 삭제 되었습니다.'},201

"""
PUT /api/link/update/<int:id> - 링크 정보 수정
"""
class LinkUpdate(Resource):

    def put(self,id):
        #Request를 json으로 받는다.
        values = request.get_json()
        # 정보 수정 ( links_model의 update_by_id 메소드 호출 )
        LinkModel.update_by_id(id, values)
        return {'message':'정보가 수정 되었습니다.'},201

참고자료 :

Sqlalchemy

Flask + marshmallow for beautiful APIs 

다음 편에는 server.py에 flask_restful에서 제공되는 API Resource을 추가해 보자.