質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

88.58%

pythonでのWEB APIをどのようなディレクトリ・ファイル構造で作成するのがよいですか

受付中

回答 0

投稿

  • 評価
  • クリップ 0
  • VIEW 799

KoshiroNomura

score 10

前提・実現したいこと

PythonにてWEB APIを作成しております。
(処理内容はまだからっぽですが。。。)

現在は下記のように一つのファイルにコードを記載しておりますが、
ファイルをjson定義、実処理等に分割したいと考えています。

いろいろなサイトみてもなにがいいのかがよくわからず、
下記の内容のソースであればどのようなディレクトリ構造、ファイル構造がいいのでしょうか。

該当のソースコード

from functools import wraps

from flask import Flask, render_template, jsonify, request, url_for, abort, Response, json
from flask_restplus import Api, Resource, fields, Namespace
from flask_sqlalchemy import SQLAlchemy

# API情報を指定して初期化
app = Flask(__name__)

#日本語の文字化け回避
app.config['JSON_AS_ASCII'] = False

#DB接続情報
app.config['SQLALCHEMY_DATABASE_URI'] = 'postgresql://postgres:admin@localhost/develop'
db = SQLAlchemy(app)

#APIリファレンス情報
api = Api(app, version='0.1', title='API Document', description='', doc='/doc/',
          default='Example', default_label='default label')

# Userテーブル操作 Namespaceの初期化と登録
user_namespace = Namespace('user', description='Userのエンドポイント')
# ホーム&ログイン&ログアウト Namespaceの初期化と登録
login_namespace = Namespace('login', description='Loginのエンドポイント')

#Userテーブル操作の登録
api.add_namespace(user_namespace)
#ホーム&ログイン&ログアウトの登録
api.add_namespace(login_namespace)

#jsonが送信されているかチェック
def jsonCheck(content_type):
    def _jsonCheck(function):
        @wraps(function)
        def __jsonCheck(*argv, **keywords):
            if request.headers['Content-Type'] != content_type:
                abort(400)
            return function(*argv, **keywords)
        return __jsonCheck
    return _jsonCheck

#userテーブル
class user(db.Model):
  __tablename__ = "user"
  id = db.Column(db.Integer, primary_key=True)
  username = db.Column(db.String(100), nullable=False)
  password = db.Column(db.String(100), nullable=False, default=False)

#JSONモデルの定義 user
user = login_namespace.model('User', {
    'username': fields.String(
        required=True,
        description='ログインユーザ名',
        example='username'
    ),
    'password': fields.String(
        required=True,
        description='ログインパスワード',
        example='password'
    )
})

#JSONモデルの定義 status
status = login_namespace.model('Status', {
    'status': fields.String(
        required=True,
        description='ステータス',
        example='status'
    )
})

@user_namespace.route('/user')
class user(Resource):
    def get(self):
        """
        ユーザを取得する
        """
        return render_template('index.html')

    @jsonCheck('application/json')
    def post(self):
        """
        ユーザを登録する
        """
        return render_template('index.html')

    @jsonCheck('application/json')
    def put(self):
        """
        ユーザを更新する
        """
        return render_template('index.html')

    @jsonCheck('application/json')
    def delete(self):
        """
        ユーザを削除する
        """
        return render_template('index.html')

@login_namespace.route('/user')
class home(Resource):
    def get(self):
        """
        トップページを取得する
        ログインセッションが張られていない場合、303 See Otherを返す
        """
        return render_template('index.html')

@login_namespace.route('/auth/login')
class login(Resource):
    def get(self):
        """
        ログインページ取得を行う
        ログインページを返す
        """
        return render_template('login.html')

    @login_namespace.expect(user, validate=True)
    @login_namespace.marshal_with(status)
    @jsonCheck('application/json')
    # userモデルを利用して結果をパースして単体で返す
    def post(self):
        """
        ログインを行う
        ログインに成功した場合、レスポンスのCookieに有効なセッション情報を設定して返す
        (以降ログイン中は、リクエストヘッダーのCookieにこのセッション情報を指定する必要がある)
        """
        #jsonを受け取る
        username = request.json['username']
        password = request.json['password']
        print(username)
        print(password)

        #ユーザテーブルを検索する

        #存在した場合、ログインOK

        #存在しない場合、ログイン失敗

        return ""
  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 過去に投稿した質問と同じ内容の質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

まだ回答がついていません

15分調べてもわからないことは、teratailで質問しよう!

  • ただいまの回答率 88.58%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる

関連した質問

同じタグがついた質問を見る