MSA에서 Gateway 활용하기 (기존 API를 Wrapping하기)

심재훈 23.10.19

3,064 18 0

facebook twitter kakao link

18 0

facebook twitter kakao link

DEVOTEE 요약: SK하이닉스는 Google Sheets나 Airtable과 같은 웹 기반 스프레드 시트인 Goodocs를 운영하며, 이를 위한 API를 제공하지만 복잡해 한 번의 호출로 모든 데이터를 불러오기 어렵다. 이에 Gateway 서버를 만들어 기존 API를 Wrapping함으로써 편리하게 데이터를 불러올 수 있도록 제안하며, 그 과정은 Python의 FastAPI로 구현하고 기존에 복잡했던 부분을 간결하게 만든다. 이로써 각각 필요한 데이터 형태를 원하는 대로 받을 수 있어, 특히 마이크로 서비스 아키텍처에서는 각 부서가 필요에 따라 이런 Gateway를 만들어 사용하는 것이 효율적이다.

DEVOTEE 추천 블로그

개요

SK하이닉스에서는 Google Sheets, Airtable과 비슷한 웹기반 스프레드 시트 Goodocs를 운영하고 있습니다.

Goodocs 서비스는 업무 자동화를 위해 API를 제공하고 있는데요.

키값 하나로 데이터를 전부 받으려면 코드를 여러 줄 작성해야 하는 불편함이 있습니다.

기존 API가 불편하게 구성되어 있어, 매번 불편하게 이용하는건 별로겠죠?

이럴 때 Gateway 서버를 만들어서 기존 API를 Wrapping하면 좋습니다!

Gateway를 구성하면 다른 서비스에서도 이용할 수 있고, 좀 더 본인의 필요에 맞게 API를 구성할 수 있기 때문이죠.

결과물 Preview

Gateway를 만들어서 편하게 데이터를 불러오는 것이 목표입니다.

기존 API 구성

기존 API는 아래와 같이 데이터를 불러올 수 있습니다.

rows, cols 따로 불러와야 합니다.

저희가 원하는 테이블 형태의 데이터를 받으려면 rows, cols를 조합해야 돼요.

import json
import requests

ROOT = '.../openAPI/v1'
HEADERS = {'Content-type': 'application/json'}


def get_cols(doc_id, params):
    url = f'{ROOT}/column'
    params['DOC_ID'] = str(doc_id)
    response = requests.post(url, headers=HEADERS, data=json.dumps(params))
    cols_str = response.json()['COLS']
    cols_raw = json.loads(cols_str)
    return cols


def get_rows(doc_id, params):
    url = f'{ROOT}/row'
    params['DOC_ID'] = str(doc_id)
    response = requests.post(url, headers=HEADERS, data=json.dumps(params))
    rows_str = response.json()['ROWS']
    rows_raw = json.loads(rows_str)
    return rows_raw


params = {'USER_ID': '...', ...}
doc_id = '...'
rows = get_rows(doc_id, params)
cols = get_cols(doc_id, params)

rows에서 원하는 데이터를 받았지만, 열 이름은 키값으로만 받았습니다.

cols는 데이터는 있지만, 저희가 원하는 {키값: 열 이름} 형태로 받진 못했습니다.

원하는 Gateway 구성

저희가 원하는건 API 호출 한번으로 DataFrame을 만드는 것입니다.

import requests
import pandas as pd

BASE_URL = '.../api/v1/gooddocs'
params = {'USER_ID': '...', ...}
doc_id = '...'
url = f'{BASE_URL}/{doc_id}/'
response = requests.get(url, params=params)
rows = response.json()

data = pd.DataFrame(rows)

FastAPI로 Gateway 만들기

이제 원하는 서비스를 만들면 됩니다.

rows, cols를 기존 API에서 받아와서 가공을 해주고, API로 만들어줍니다.

# util.py
import json
import requests

ROOT = '.../openAPI/v1'
HEADERS = {'Content-type': 'application/json'}


def get_cols(doc_id, params):
    url = f'{ROOT}/column'
    params['DOC_ID'] = str(doc_id)
    response = requests.post(url, headers=HEADERS, data=json.dumps(params))
    cols_str = response.json()['COLS']
    cols_raw = json.loads(cols_str)
    cols = {}
    for col in cols_raw:
        if 'userSetting' not in col:
            continue
        field = col['field']
        name = col['headerName']
        cols[field] = name
    return cols


def get_rows(doc_id, params):
    url = f'{ROOT}/row'
    params['DOC_ID'] = str(doc_id)
    response = requests.post(url, headers=HEADERS, data=json.dumps(params))
    rows_str = response.json()['ROWS']
    rows_raw = json.loads(rows_str)
    cols = get_cols(doc_id, params)
    rows = []
    for row in rows_raw:
        new_row = {}
        for col, name in cols.items():
            new_row[name] = row[col]
        rows.append(new_row)
    return rows

# main.py
from fastapi import FastAPI
from .util import get_rows

app = FastAPI()


@app.get('/api/v1/gooddocs/{doc_id}')
async def read(doc_id: str, USER_ID: str, ...):
    params = {'USER_ID': USER_ID, ...}
    rows = get_rows(doc_id, params)
    return rows