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

#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설계에 빠진 것은 화면을 개발하면서 추가적으로 제작해 보기로 한다.

1.    Python으로 API 개발

Python의 Flask을 이용하여 API제작을 해보자.

우선 PostgreSQL에서 DB 설계에 맞게 테이블을 생성한다.

(DB생성 방법은 별도 설명하지 않는다.)

1.1.  Python Flask API환경 설정

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

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

config.py은 개발계(Development)와 운영계(Production) 환경설정을 위한 것으로 서버(server.py) 구동 시 호출한다.

SQLALCHEMY_DATABASE_URI정보를 여러분의 DB정보로 변경하고, 다른 옵션들은 참고하여 필요시 추가/삭제 하면 된다.

이미지 저장 위치설정은 CDN혹은 NAS형태로 제작하고자 별도 폴더로 분리했으며, 링크정보와 이미지 정보 저장은 IMAGE_URL형태로 저장된다. 

환경파일 내용은 앞으로 진행하면서 설명될 것이다. 

import os
dir = os.path.dirname(os.path.abspath(os.path.dirname(__file__)))

class Development(object):
    DEBUG = True
    FLASK_APP = 'linkservice_dev'
    ENV = 'development'
    
## DB URL FOR DEVELOPMENT
    SQLALCHEMY_DATABASE_URI = 'postgresql://사용자:사용자패스워드@localhost:5432/데이타베이스명'

# 데이터 변경사항에 대해 커밋 전후로 알림 여부
    SQLALCHEMY_TRACK_MODIFICATIONS = True

# Query Debug 여부 및 DB POOL
    SQLALCHEMY_ECHO = True
    SQLALCHEMY_POOL_SIZE = 20
    SQLALCHEMY_POOL_RECYCLE = 3600

#JSON에서 한글 표현을 위해서 반영
    JSON_AS_ASCII = False
    
#이미지 위치 설정
    image_folder = os.path.normpath(os.path.join(dir, os.pardir)) + '/client/public/images/'
    COVER_IMAGE_FORDER = image_folder
    IMAGE_FORDER = image_folder
    IMAGE_URL = 'http://127.0.0.1:3000/images/'

class Production(object):
    DEBUG = False
    SQLALCHEMY_TRACK_MODIFICATIONS = False
    SQLALCHEMY_ECHO = False
    FLASK_APP = 'linkservice'
    ENV = 'production'
    
## DB URL FOR PRODUCTION
    SQLALCHEMY_DATABASE_URI = 'postgresql://사용자:사용자패스워드@localhost:5432/데이타베이스명'

#JSON에서 한글 표현을 위해서 반영
    JSON_AS_ASCII = False    

#이미지 위치 설정
    image_folder = os.path.normpath(os.path.join(dir, os.pardir)) + '/images/'
    COVER_IMAGE_FORDER = image_folder
    IMAGE_FORDER = image_folder 

#운영계 
    IMAGE_URL = 'https://www.linkservice.com/img/'

app_config = {
    'development': Development(),
    'production': Production(),
}

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

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

create_app.py는 환경파일을 읽어 Flask App을 실행한다.

from . import config
from flask import Flask

def create_app(environment):
    # config파일에서 불려오기
    config_map = {
        'development': config.Development(),
        'production': config.Production(),
    }
    config_obj = config_map[environment.lower()]   
    
    app = Flask(__name__)
    app.config.from_object(config_obj)

    return app