RESTPlus 생성

Author: msnodeve

Pipfile

@@ -14,6 +14,7 @@ flask-script = "*"
 flask-sqlalchemy = "*"
 flask-migrate = "*"
 pymysql = "*"
+flask-restplus = "*"
 
 [requires]
 python_version = "3.7"

Pipfile.lock

@@ -3,15 +3,23 @@
 """
 
 from flask import Flask
+from flask_restplus import Resource, Api, fields, reqparse
 from flask_sqlalchemy import SQLAlchemy
+from sqlalchemy.exc import SQLAlchemyError
 from sqlalchemy.sql import text
 
 DB = SQLAlchemy()
 SQLALCHEMY_DATABASE_URI = \
     ("mysql+pymysql://{USER}:{PASSWORD}@{ADDR}:{PORT}/{NAME}?charset=utf8")
+    
+# API Doc에 대한 설명을 덧 붙이기 위한 생성자
+API = Api(version='1.0', title='Board API',
+    description='A simple Board RESTPlus API',)
+# 설명할 API에 대한 것
+api_ns = API.namespace('userinfo', description='UserInfo operations')
 
-class Userinfo(DB.Model):
-    """ Userinfo model """
+class UserInfo(DB.Model):
+    """ UserInfo model """
     __tablename__ = "userinfo"
     __table_args__ = {'mysql_collate' : 'utf8_general_ci'}
     id = DB.Column("id", DB.Integer, primary_key=True)
@@ -26,6 +34,8 @@ def __init__(self, name, tel):
 def create_app() -> (Flask):
     """ create_app() 함수를 호출해 앱을 초기화 """
 
+
+
     """ app config part """
     # 나중에 config는 다 빼야 할 것 같다.
     app = Flask(__name__)
@@ -40,10 +50,55 @@ def create_app() -> (Flask):
     app.config['SQLALCHEMY_ECHO'] = True
     app.config['DEBUG'] = True
     DB.init_app(app)
+    API.init_app(app)
+
+
+
+    """ API model을 보이기 위한 설명 추가 """
+    # 나중에 따로 빼야 할 것 같다.
+    user_info = API.model('UserInfo', {
+        'name' : fields.String(required=True, description="User's name"),
+        'tel' : fields.String(required=True, description="User's tel")
+    })
+
+
+
+    """ API.route part"""
+    @api_ns.route("/hello")
+    class HelloWorld(Resource):
+        def get(self):
+            return {'hello': 'world'}
+
+    @api_ns.route('/users')
+    class HelloWorld(Resource):
+        post_parser = reqparse.RequestParser(bundle_errors=True)
+        post_parser.add_argument('name', required=True, type=str, help="user name",location='json')
+        post_parser.add_argument('tel', type=str, help="user tel",location='json')
+
+        def get(self):
+            userInfo = DB.session.query(UserInfo).all()
+            return {'hello': 'world'}
+
+        @api_ns.expect(user_info)
+        def post(self):
+            """ 유저 생성 """
+            args_ = self.post_parser.parse_args()
+            user = UserInfo(name=args_['name'], tel=args_['tel'])
+            message = "not working"
+            try:
+                DB.session.add(user)
+                DB.session.commit()
+                message = "success"
+            except SQLAlchemyError as err:
+                message = str(err)
+                DB.session.rollback()
+            finally:
+                DB.session.close()
+            return message
 
-    """ route part """
+    """ app.route part """
     # 나중에 route는 다 빼야 할 것 같다.
-    @app.route("/")
+    @app.route("/index")
     def index():
         """ / url index """
         return "<h1>Hello World ! <br> This is index page</h1>"

app/__init__.py

@@ -6,7 +6,7 @@
 from flask_migrate import Migrate, MigrateCommand
 from app import create_app
 from app import DB
-from app import Userinfo
+from app import UserInfo
 
 APP = create_app()
 MANAGER = Manager(APP)