flask [웹서버] Flask + REST API + Swagger

2021.04.04 00:32

졸리운_곰 조회 수:431

[웹서버] Flask + REST API + Swagger

Python 경량 웹프레임워크 Flask를 이용하여 REST API를 만들고

Swagger를 이용하여 API Spec를 웹으로 조회할 수 있도록 합니다.

아래 순서로 진행하겠습니다.

1) 미니아나콘다 도커 이미지를 가져오고 실행합니다.

2) 필요한 모듈을 설치합니다.

3) 소스코드를 작성합니다.

4) 실행합니다.

1) 미니콘다 도커 이미지를 가져오고 실행합니다.

# 최신 미니콘다 이미지를 가져온다

docker pull continuumio/miniconda3:4.6.14

# 9991포트(변경 가능) 오픈&매핑한다. 볼륨(변경 가능)을 연결하고 bash를 실행한다

docker run -it -p 9991:9991 -v C:\workspace\:/workspace/ continuumio/miniconda3:4.6.14 bash

2) 필요한 모듈을 설치합니다.

# apt-get 업데이트한다

apt-get update

# vim 을 설치한다 apt-get install -y vim

# conda 업데이트한다

conda update -y conda

# flask를 설치한다

conda install -y flask

# flask-1.0.3, jinja2-2.10.1, werkzeug-0.15.4 설치됨

# itsdangerous-1.1.0, markupsafe-1.1.1, click-7.0 설치됨

# pip 업데이트한다

pip install --upgrade pip

# flask-restplus 설치한다

pip install flask-restplus

# flask-restplus-0.12.1, aniso8601-7.0.0, attrs-19.1.0 설치됨

# jsonschema-3.0.1, pyrsistent-0.15.2, pytz-2019.1 설치됨

3) 소스코드를 작성합니다.

cd /workspace

vim app.py

[app.py 파일]

경축! 아무것도 안하여 에스천사게임즈가 새로운 모습으로 재오픈 하였습니다.
어린이용이며, 설치가 필요없는 브라우저 게임입니다.
https://s1004games.com

# 필요한 모듈을 불러온다
from flask import Flask, request
from flask_restplus import Api, Resource, fields
app = Flask(__name__) # Flask App 생성한다
api = Api(app, version='1.0', title='상품 관리 API', description='상품 등록,수정,삭제,조회 API입니다') # API 만든다
ns  = api.namespace('goods', description='상품 등록,수정,삭제,조회') # /goods/ 네임스페이스를 만든다
# REST Api에 이용할 데이터 모델을 정의한다
model_goods = api.model('row_goods', {
    'id': fields.Integer(readOnly=True, required=True, description='상품번호', help='상품번호는 필수'),
    'goods_name': fields.String(required=True, description='상품명', help='상품명은 필수')
})
class GoodsDAO(object):
    '''상품정보 Data Access Object'''
    def __init__(self):
        self.counter = 0
        self.rows    = []
    def get(self, id):
        '''id를 이용하여 상품정보 조회한다'''
        for row in self.rows:
            if row['id'] == id:
                return row
        api.abort(404, "{} doesn't exist".format(id))
    def create(self, data):
        '''신규 상품을 등록한다'''
        row = data
        row['id'] = self.counter = self.counter + 1
        self.rows.append(row)
        return row
    def update(self, id, data):
        '''입력 id의 data를 수정한다'''
        row = self.get(id)
        row.update(data)
        return row
    def delete(self, id):
        '''입력 id의 data를 삭제한다'''
        row = self.get(id)
        self.rows.remove(row)
DAO = GoodsDAO() # DAO 객체를 만든다
DAO.create({'goods_name': '삼성 노트북 9'}) # 샘플 1 데이터 만든다
DAO.create({'goods_name': 'LG 노트북 gram'}) # 샘플 2 데이터 만든다

@ns.route('/') # 네임스페이스 x.x.x.x/goods 하위 / 라우팅
class GoodsListManager(Resource):
    @ns.marshal_list_with(model_goods)
    def get(self):
        '''전체 리스트 조회한다'''
        return DAO.rows
    @ns.expect(model_goods)
    @ns.marshal_with(model_goods, code=201)
    def post(self):
        '''새로운 id 추가한다'''
        # request.json[파라미터이름]으로 파라미터값 조회할 수 있다
        print('input goods_name is', request.json['goods_name'])
        return DAO.create(api.payload), 201

@ns.route('/<int:id>') # 네임스페이스 x.x.x.x/goods 하위 /숫자 라우팅
@ns.response(404, 'id를 찾을 수가 없어요')
@ns.param('id', '상품번호를 입력해주세요')
class GoodsRUDManager(Resource):
    @ns.marshal_with(model_goods)
    def get(self, id):
        '''해당 id 상품정보를 조회한다'''
        return DAO.get(id)
    def delete(self, id):
        '''해당 id 삭제한다'''
        DAO.delete(id)
        return '', 200
    @ns.expect(model_goods)
    @ns.marshal_with(model_goods)
    def put(self, id):
        '''해당 id 수정한다'''
        return DAO.update(id, api.payload)

# flask명령어를 실행한다

FLASK_APP=app.py flask run -h 0.0.0.0 -p 9991

브라우져를 이용하여 접속해 봅니다.

http://127.0.0.1:9991

전체 리스트를 조회해 봅니다.( GET /goods/ )

Try it out 버튼을 클릭하거나 아래 curl 명령어로 호출할 수 있습니다.

curl -X GET "http://127.0.0.1:9991/goods/"

전체 리스트가 조회되었습니다

id 2번만 조회해 봅니다. ( GET /goods/{id} )

Try it out 버튼을 클릭하거나 아래 curl 명령어로 호출할 수 있습니다.

curl -X GET "http://127.0.0.1:9991/goods/2"

2번 상품 LG노트북 gram을 확인할 수 있습니다

끝.

[출처] https://blog.naver.com/wideeyed/221571623994

본 웹사이트는 광고를 포함하고 있습니다.
광고 클릭에서 발생하는 수익금은 모두 웹사이트 서버의 유지 및 관리, 그리고 기술 콘텐츠 향상을 위해 쓰여집니다.

이 게시물을

번호	제목	글쓴이	날짜	조회 수
2	[pySide] [번역] PySide6 - 시그널, 슬롯 & 이벤트	졸리운_곰	2023.12.27	319
1	[pySide] [번역] PySide6로 첫 번째 앱 만들기 !	졸리운_곰	2023.12.27	546

첫 페이지 1 끝 페이지

쓰기

태그

flask [웹서버] Flask + REST API + Swagger

[웹서버] Flask + REST API + Swagger

경축! 아무것도 안하여 에스천사게임즈가 새로운 모습으로 재오픈 하였습니다. 어린이용이며, 설치가 필요없는 브라우저 게임입니다. https://s1004games.com

댓글 0

로그인

경축! 아무것도 안하여 에스천사게임즈가 새로운 모습으로 재오픈 하였습니다.
어린이용이며, 설치가 필요없는 브라우저 게임입니다.
https://s1004games.com