Python | FastAPIでAPI作成　～その９：herokuを利用する（app作成からPostgreSQL利用まで）～

2022.07.28
FAST API

今回は前回の続きで、「PaaS」を提供している「heroku」にアプリを乗せてみましょう。

ちょっと長いので、2回に分けて掲載します。

Part１：herokuで環境構築＆DB作成　←今回！

Part２：appをデプロイ＆接続テスト

前回の記事は以下から↓

魅せるIT編集部

2022.07.19

Python | FastAPIでAPI作成　～その８：データベース（SQLite3）と連携

https://miseruit.com/2022/07/19/post-2970

今回は前回の続きとして、データベースとの連携を行います。前回の記事は以下から↓今回は「sqlite3」を用います。sqlite3データベースの環境を準備します。（※事前にsqlite3はインストールしているものとします。）インストール方法は以下の記事に纏めています。今回は、.pyファイルのカレントディレクトリ上に「User.db」を作成します。①コマンドプロンプトを開くWin + R -> cmd②カレントディレクトリに移動cd でpyファイルが置かれているフォルダに移動③dbの作成以下のコマンドでdbを作成します。sqlite3 User.db④テーブルの作成...

1. herokuとは？
2. 手順

herokuとは？

以下がWikipediaの情報です。

jp.heroku.com

クラウド・アプリケーション・プラットフォーム | Heroku

https://jp.heroku.com

Heroku は、アプリケーションの開発から実行、運用までのすべてをクラウドで完結できる PaaS（サービスとしてのプラットフォーム）です。

ベースとなるオペレーティングシステム (OS) はDebian、もしくはDebianをベースに開発されたUbuntuである。
初期はRubyによるウェブアプリケーションフレームワーク Ruby on Railsのみのサポートであったが、Java、Node.js、Scala、Clojure、Python、PHP、Goなど複数のプログラミング言語をサポートするようになった。
データベースはPostgreSQL、MySQL、Cloudant（英語版）、Couchbase Server、MongoDB、Redisをサポートしている。
Heroku DNS Serverで実行されるアプリケーションは、FQDNが「アプリケーション名.herokuapp.com」となる。
Wikipediaより引用

手順

以下に手順を記載します。

①herokuにログインする

以下のURLからherokuにログインします。（アカウントは既に作成済とします）

id.heroku.com

Heroku | Login

https://id.heroku.com/login

②アプリケーションを作成する

画面右側 New>Create new appをクリックします。

以下のフォームに「App name」を入力する。

region（リージョン）は United States　もしくは　Europe　のいずれかを選択。

利用するデータセンタの場所なので、日本に近いほうがいい？

③PaaS上にデータベースを作成する

作成したアプリケーションで利用するDBを作成します。今回はPostgreSQLを利用します。

１：上側タブ「Resources」をクリック

２：Addonの検索項目で「Heroku Postgres」と入力し、検索結果を選択する

３：作成したDBは以下から参照できます。

画面右上＞Data（Heroku Data）から作成したDBの一覧が確認できます。

④HerokuCLIをインストールする

データのやり取りやアプリケーションをデプロイするにあたり、HerokuCLIが必要になってきますのでインストールします。

インストールは以下のリンク先から実行できます。

devcenter.heroku.com

The Heroku CLI | Heroku Dev Center

https://devcenter.heroku.com/articles/heroku-cli

How to download, install, and start using, the Heroku CLI. The Heroku CLI used to be part of the Heroku Toolbelt.

インストーラを実行します。

⑤ローカル環境にPostgreSQLをインストールする

Heroku PostgreSQLを利用するには、ローカルにもPostgreSQLを入れておく必要があるらしく、インストールします。

以下のリンクからPostgreSQLのインストーラを取得します。

EnterpriseDB

Download PostgreSQL

https://www.enterprisedb.com/downloads/postgres-postgresql-downloads

PostgreSQL Database Download

インストーラを起動して、PostgreSQLをインストールします。（当たり前ですが、ユーザ「admin」のパスワードは忘れないように・・・・私は何度か忘れたことがあります・・・・）

⑥psqlコマンドが利用できるように環境設定する

PostgreSQL 14でデフォルト設定した場合は、以下の場所にパスを通します。

C:\Program Files\PostgreSQL\14\bin

コマンドプロンプトで「psql」を実行し、ログインを求められればパスが通っています。

⑦作成したデータベースにデータを登録する

やっと準備が整いました。

HrokuCLIを利用して「Heroku PostgreSQL」に接続してみます。

１：画面右上＞Data（Heroku Data）から作成したDBの一覧を表示し、接続したいDBを選択します。

２：対象のDBのDatastore>Settings＞Database Credentialsを選択します。

この中の「Heroku CLI」をクリップボードにコピーします。

３：コマンドプロンプトを開き、先ほどのコマンドをペーストして実行します。

以下のようにDatabaseに接続できれば成功です。

お試し：PostgreSQLでデータ操作

テーブルを作成

create table User_list ( ID TEXT NOT NULL, Name TEXT, Class TEXT);

データを挿入

insert into User_list values('M001','Takashi','A'); 
insert into User_list values('M002','Hanako','A'); 
insert into User_list values('M003','Hiroshi','B'); 
insert into User_list values('M004','Kyoko','B');

データを抽出