【Flask】REST APIでBlueprintを使ってルーティングを整理する

Copy
pip install flask

Copy
.
├── api
│   └── api.py

Copy
from flask import Flask

# flaskインスタンス作成
api = Flask(__name__)

# usersリソース
users = [
    {"user_id": "1", "name": "tujimura", "age": 11},
    {"user_id": "2", "name": "mori", "age": 20},
    {"user_id": "3", "name": "shimada", "age": 50},
    {"user_id": "4", "name": "kyogoku", "age": 70}]

# booksリソース
books = [
    {"book_id": "1", "book_name": "凍りのクジラ"},
    {"book_id": "2", "book_name": "全てがFになる"},
    {"book_id": "3", "book_name": "占星術殺人事件"},
    {"book_id": "4", "book_name": "姑獲鳥の夏"}]

# usersルーティング
@api.route('/users', methods=['GET'])
def get_users():
    # 取得
    return users

# booksルーティング
@api.route('/books', methods=['GET'])
def get_books():
    # 取得
    return books

Copy
.
├── api
│   ├── api.py
│   └── api_resource
│       ├── __init___.py
│       ├── booksAPI.py
│       └── userAPI.py

Copy
from flask import Blueprint

# blueprintインスタンス作成(users)
bp = Blueprint('users', __name__)

# usersリソース
users = [
    {"user_id": "1", "name": "tujimura", "age": 11},
    {"user_id": "2", "name": "mori", "age": 20},
    {"user_id": "3", "name": "shimada", "age": 50},
    {"user_id": "4", "name": "kyogoku", "age": 70}]

# usersルーティング
@bp.route('/users', methods=['GET'])
def get_users():
    # 取得
    return users

Copy
from flask import Blueprint
from flask_restful import Api, Resource

# blueprintインスタンス作成(books)
bp = Blueprint('books', __name__)

# booksリソース
books = [
    {"book_id": "1", "book_name": "凍りのクジラ"},
    {"book_id": "2", "book_name": "全てがFになる"},
    {"book_id": "3", "book_name": "占星術殺人事件"},
    {"book_id": "4", "book_name": "姑獲鳥の夏"}]

# booksルーティング
@bp.route('/books', methods=['GET'])
def get_books():
    # 取得
    return books

Copy
bp = Blueprint('users', __name__)

Copy
from flask import Flask
from api.api_resource import userAPI
from api.api_resource import booksAPI

# flaskインスタンス作成
api = Flask(__name__)

# flaskインスタンスにblueprintインスタンスを登録
api.register_blueprint(userAPI.bp, url_prefix = '/api')
api.register_blueprint(booksAPI.bp, url_prefix = '/api')

if __name__ == "__main__":
    # flaskサーバーを起動
    api.run()

Copy
.
├── api
│   └── api.py

Copy
from flask import Flask
from flask_restful import Api, Resource

# flaskインスタンス作成
api = Flask(__name__)

# flask_restfulのApiインスタンス作成
flask_api = Api(api)

# usersリソース
users = [
    {"user_id": "1", "name": "tujimura", "age": 11},
    {"user_id": "2", "name": "mori", "age": 20},
    {"user_id": "3", "name": "shimada", "age": 50},
    {"user_id": "4", "name": "kyogoku", "age": 70}]

# booksリソース
books = [
    {"book_id": "1", "book_name": "凍りのクジラ"},
    {"book_id": "2", "book_name": "全てがFになる"},
    {"book_id": "3", "book_name": "占星術殺人事件"},
    {"book_id": "4", "book_name": "姑獲鳥の夏"}]

# usersルーティング
class UserAPI(Resource):
    # 取得
    def get(self):
        return users

# booksルーティング
class BooksAPI(Resource):
    # 取得
    def get(self):
        return books

# エンドポイントを設定
flask_api.add_resource(UserAPI, '/users')
flask_api.add_resource(BooksAPI, '/books')

Copy
.
├── api
│   ├── api.py
│   └── api_resource
│       ├── __init___.py
│       ├── booksAPI.py
│       └── userAPI.py

Copy
from flask import Blueprint
from flask_restful import Api, Resource

# blueprintインスタンス作成(users)
bp = Blueprint('users', __name__)

# flask_restfulのApiインスタンス作成
# blueprintインスタンスを紐づける
flask_api = Api(bp)

# usersリソース
users = [
    {"user_id": "1", "name": "tujimura", "age": 11},
    {"user_id": "2", "name": "mori", "age": 20},
    {"user_id": "3", "name": "shimada", "age": 50},
    {"user_id": "4", "name": "kyogoku", "age": 70}]

# usersルーティング
class UserAPI(Resource):
    # 取得
    def get(self):
        return users

# エンドポイントを設定
flask_api.add_resource(UserAPI, '/users')

Copy
from flask import Blueprint
from flask_restful import Api, Resource

# blueprintインスタンス作成(books)
bp = Blueprint('books', __name__)

# flask_restfulのApiインスタンス作成
# blueprintインスタンスを紐づける
flask_api = Api(bp)

# booksリソース
books = [
    {"book_id": "1", "book_name": "凍りのクジラ"},
    {"book_id": "2", "book_name": "全てがFになる"},
    {"book_id": "3", "book_name": "占星術殺人事件"},
    {"book_id": "4", "book_name": "姑獲鳥の夏"}]

# booksルーティング
class BooksAPI(Resource):
    # 取得
    def get(self):
        return books

# エンドポイントを設定
flask_api.add_resource(BooksAPI, '/books')

Copy
from flask import Flask
from api.api_resource import userAPI
from api.api_resource import booksAPI

# flaskインスタンス作成
api = Flask(__name__)
api.register_blueprint(userAPI.bp, url_prefix = '/api')
api.register_blueprint(booksAPI.bp, url_prefix = '/api')

if __name__ == "__main__":
    # flaskサーバーを起動
    api.run()

Copy
── flaskインスタンス
    ├── blueprintインスタンス(users)
    └── blueprintインスタンス(books)

Copy
── flaskインスタンス
    ├── blueprintインスタンス(users) ── Apiインスタンス(users)
    └── blueprintインスタンス(books) ── Apiインスタンス(books)