Browse Source
Co-authored-by: Taki Komiyama <[email protected]> Co-authored-by: Sebastián Ramírez <[email protected]>pull/2621/head
committed by
GitHub
2 changed files with 241 additions and 0 deletions
@ -0,0 +1,240 @@ |
|||||
|
# Deta にデプロイ |
||||
|
|
||||
|
このセクションでは、**FastAPI** アプリケーションを <a href="https://www.deta.sh/?ref=fastapi" class="external-link" target="_blank">Deta</a> の無料プランを利用して、簡単にデプロイする方法を学習します。🎁 |
||||
|
|
||||
|
所要時間は約**10分**です。 |
||||
|
|
||||
|
!!! info "備考" |
||||
|
<a href="https://www.deta.sh/?ref=fastapi" class="external-link" target="_blank">Deta</a> は **FastAPI** のスポンサーです。🎉 |
||||
|
|
||||
|
## ベーシックな **FastAPI** アプリ |
||||
|
|
||||
|
* アプリのためのディレクトリ (例えば `./fastapideta/`) を作成し、その中に入ってください。 |
||||
|
|
||||
|
### FastAPI のコード |
||||
|
|
||||
|
* 以下の `main.py` ファイルを作成してください: |
||||
|
|
||||
|
```Python |
||||
|
from fastapi import FastAPI |
||||
|
|
||||
|
app = FastAPI() |
||||
|
|
||||
|
|
||||
|
@app.get("/") |
||||
|
def read_root(): |
||||
|
return {"Hello": "World"} |
||||
|
|
||||
|
|
||||
|
@app.get("/items/{item_id}") |
||||
|
def read_item(item_id: int): |
||||
|
return {"item_id": item_id} |
||||
|
``` |
||||
|
|
||||
|
### Requirements |
||||
|
|
||||
|
では、同じディレクトリに以下の `requirements.txt` ファイルを作成してください: |
||||
|
|
||||
|
```text |
||||
|
fastapi |
||||
|
``` |
||||
|
|
||||
|
!!! tip "豆知識" |
||||
|
アプリのローカルテストのために Uvicorn をインストールしたくなるかもしれませんが、Deta へのデプロイには不要です。 |
||||
|
|
||||
|
### ディレクトリ構造 |
||||
|
|
||||
|
以下の2つのファイルと1つの `./fastapideta/` ディレクトリがあるはずです: |
||||
|
|
||||
|
``` |
||||
|
. |
||||
|
└── main.py |
||||
|
└── requirements.txt |
||||
|
``` |
||||
|
|
||||
|
## Detaの無料アカウントの作成 |
||||
|
|
||||
|
それでは、<a href="https://www.deta.sh/?ref=fastapi" class="external-link" target="_blank">Detaの無料アカウント</a>を作成しましょう。必要なものはメールアドレスとパスワードだけです。 |
||||
|
|
||||
|
クレジットカードさえ必要ありません。 |
||||
|
|
||||
|
## CLIのインストール |
||||
|
|
||||
|
アカウントを取得したら、Deta <abbr title="Command Line Interface application">CLI</abbr> をインストールしてください: |
||||
|
|
||||
|
=== "Linux, macOS" |
||||
|
|
||||
|
<div class="termy"> |
||||
|
|
||||
|
```console |
||||
|
$ curl -fsSL https://get.deta.dev/cli.sh | sh |
||||
|
``` |
||||
|
|
||||
|
</div> |
||||
|
|
||||
|
=== "Windows PowerShell" |
||||
|
|
||||
|
<div class="termy"> |
||||
|
|
||||
|
```console |
||||
|
$ iwr https://get.deta.dev/cli.ps1 -useb | iex |
||||
|
``` |
||||
|
|
||||
|
</div> |
||||
|
|
||||
|
インストールしたら、インストールした CLI を有効にするために新たなターミナルを開いてください。 |
||||
|
|
||||
|
新たなターミナル上で、正しくインストールされたか確認します: |
||||
|
|
||||
|
<div class="termy"> |
||||
|
|
||||
|
```console |
||||
|
$ deta --help |
||||
|
|
||||
|
Deta command line interface for managing deta micros. |
||||
|
Complete documentation available at https://docs.deta.sh |
||||
|
|
||||
|
Usage: |
||||
|
deta [flags] |
||||
|
deta [command] |
||||
|
|
||||
|
Available Commands: |
||||
|
auth Change auth settings for a deta micro |
||||
|
|
||||
|
... |
||||
|
``` |
||||
|
|
||||
|
</div> |
||||
|
|
||||
|
!!! tip "豆知識" |
||||
|
CLI のインストールに問題が発生した場合は、<a href="https://docs.deta.sh/docs/micros/getting_started?ref=fastapi" class="external-link" target="_blank">Deta 公式ドキュメント</a>を参照してください。 |
||||
|
|
||||
|
## CLIでログイン |
||||
|
|
||||
|
CLI から Deta にログインしてみましょう: |
||||
|
|
||||
|
<div class="termy"> |
||||
|
|
||||
|
```console |
||||
|
$ deta login |
||||
|
|
||||
|
Please, log in from the web page. Waiting.. |
||||
|
Logged in successfully. |
||||
|
``` |
||||
|
|
||||
|
</div> |
||||
|
|
||||
|
自動的にウェブブラウザが開いて、認証処理が行われます。 |
||||
|
|
||||
|
## Deta でデプロイ |
||||
|
|
||||
|
次に、アプリケーションを Deta CLIでデプロイしましょう: |
||||
|
|
||||
|
<div class="termy"> |
||||
|
|
||||
|
```console |
||||
|
$ deta new |
||||
|
|
||||
|
Successfully created a new micro |
||||
|
|
||||
|
// Notice the "endpoint" 🔍 |
||||
|
|
||||
|
{ |
||||
|
"name": "fastapideta", |
||||
|
"runtime": "python3.7", |
||||
|
"endpoint": "https://qltnci.deta.dev", |
||||
|
"visor": "enabled", |
||||
|
"http_auth": "enabled" |
||||
|
} |
||||
|
|
||||
|
Adding dependencies... |
||||
|
|
||||
|
|
||||
|
---> 100% |
||||
|
|
||||
|
|
||||
|
Successfully installed fastapi-0.61.1 pydantic-1.7.2 starlette-0.13.6 |
||||
|
``` |
||||
|
|
||||
|
</div> |
||||
|
|
||||
|
次のようなJSONメッセージが表示されます: |
||||
|
|
||||
|
```JSON hl_lines="4" |
||||
|
{ |
||||
|
"name": "fastapideta", |
||||
|
"runtime": "python3.7", |
||||
|
"endpoint": "https://qltnci.deta.dev", |
||||
|
"visor": "enabled", |
||||
|
"http_auth": "enabled" |
||||
|
} |
||||
|
``` |
||||
|
|
||||
|
!!! tip "豆知識" |
||||
|
あなたのデプロイでは異なる `"endpoint"` URLが表示されるでしょう。 |
||||
|
|
||||
|
## 確認 |
||||
|
|
||||
|
それでは、`endpoint` URLをブラウザで開いてみましょう。上記の例では `https://qltnci.deta.dev` ですが、あなたのURLは異なるはずです。 |
||||
|
|
||||
|
FastAPIアプリから返ってきたJSONレスポンスが表示されます: |
||||
|
|
||||
|
```JSON |
||||
|
{ |
||||
|
"Hello": "World" |
||||
|
} |
||||
|
``` |
||||
|
|
||||
|
そして `/docs` へ移動してください。上記の例では、`https://qltnci.deta.dev/docs` です。 |
||||
|
|
||||
|
次のようなドキュメントが表示されます: |
||||
|
|
||||
|
<img src="/img/deployment/deta/image01.png"> |
||||
|
|
||||
|
## パブリックアクセスの有効化 |
||||
|
|
||||
|
デフォルトでは、Deta はクッキーを用いてアカウントの認証を行います。 |
||||
|
|
||||
|
しかし、準備が整えば、以下の様に公開できます: |
||||
|
|
||||
|
<div class="termy"> |
||||
|
|
||||
|
```console |
||||
|
$ deta auth disable |
||||
|
|
||||
|
Successfully disabled http auth |
||||
|
``` |
||||
|
|
||||
|
</div> |
||||
|
|
||||
|
ここで、URLを共有するとAPIにアクセスできるようになります。🚀 |
||||
|
|
||||
|
## HTTPS |
||||
|
|
||||
|
おめでとうございます!あなたの FastAPI アプリが Deta へデプロイされました!🎉 🍰 |
||||
|
|
||||
|
また、DetaがHTTPSを正しく処理するため、その処理を行う必要がなく、クライアントは暗号化された安全な通信が利用できます。✅ 🔒 |
||||
|
|
||||
|
## Visor を確認 |
||||
|
|
||||
|
ドキュメントUI (`https://qltnci.deta.dev/docs` のようなURLにある) は *path operation* `/items/{item_id}` へリクエストを送ることができます。 |
||||
|
|
||||
|
ID `5` の例を示します。 |
||||
|
|
||||
|
まず、<a href="https://web.deta.sh/" class="external-link" target="_blank">https://web.deta.sh</a> へアクセスします。 |
||||
|
|
||||
|
左側に各アプリの <abbr title="it comes from Micro(server)">「Micros」</abbr> というセクションが表示されます。 |
||||
|
|
||||
|
また、「Details」や「Visor」タブが表示されています。「Visor」タブへ移動してください。 |
||||
|
|
||||
|
そこでアプリに送られた直近のリクエストが調べられます。 |
||||
|
|
||||
|
また、それらを編集してリプレイできます。 |
||||
|
|
||||
|
<img src="/img/deployment/deta/image02.png"> |
||||
|
|
||||
|
## さらに詳しく知る |
||||
|
|
||||
|
様々な箇所で永続的にデータを保存したくなるでしょう。そのためには <a href="https://docs.deta.sh/docs/base/py_tutorial?ref=fastapi" class="external-link" target="_blank">Deta Base</a> を使用できます。惜しみない **無料利用枠** もあります。 |
||||
|
|
||||
|
詳しくは <a href="https://docs.deta.sh?ref=fastapi" class="external-link" target="_blank">Deta ドキュメント</a>を参照してください。 |
Loading…
Reference in new issue