From 2289211b391b9e94fe59441ae3f26e8bf4bf0fd9 Mon Sep 17 00:00:00 2001 From: tokusumi Date: Tue, 30 Jun 2020 22:58:44 +0900 Subject: [PATCH] Add Japanese translation for tutorial/index.md --- docs/ja/docs/tutorial/index.md | 80 ++++++++++++++++++++++++++++++++++ docs/ja/mkdocs.yml | 2 + 2 files changed, 82 insertions(+) create mode 100644 docs/ja/docs/tutorial/index.md diff --git a/docs/ja/docs/tutorial/index.md b/docs/ja/docs/tutorial/index.md new file mode 100644 index 000000000..a8cc814a1 --- /dev/null +++ b/docs/ja/docs/tutorial/index.md @@ -0,0 +1,80 @@ +# チュートリアル - ユーザーガイド - はじめに + +このチュートリアルは**FastAPI**のほぼすべての機能の使い方を段階的に紹介します。 + +各セクションは前のセクションを踏まえた内容になっています。しかし、トピックごとに分割されているので、特定のAPIの要求を満たすようなセクションに直接たどり着けるようになっています。 + +また、将来的にリファレンスとして機能するように構築されています。 + +従って、後でこのチュートリアルに戻ってきて必要なものを確認できます。 + +## コードを実行する + +すべてのコードブロックをコピーして直接使用できます(実際にテストされたPythonファイルです)。 + +いずれかの例を実行するには、コードを `main.py`ファイルにコピーし、` uvicorn`を次のように起動します: + +
+ +```console +$ uvicorn main:app --reload + +INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) +INFO: Started reloader process [28720] +INFO: Started server process [28722] +INFO: Waiting for application startup. +INFO: Application startup complete. +``` + +
+ +コードを記述またはコピーし、編集してローカルで実行することを**強くお勧めします**。 + +また、エディターで使用することで、FastAPIの利点が実際に示されます。作成する必要があるコードの量、すべての型チェック、自動補完などを確認できます。 + +--- + +## FastAPIをインストールする + +最初のステップは、FastAPIのインストールです。 + +チュートリアルのために、すべてのオプションの依存関係と機能をインストールしたいとき: + +
+ +```console +$ pip install fastapi[all] + +---> 100% +``` + +
+ +...これには、コードを実行するサーバーとして使用できる `uvicorn`も含まれます。 + +!!! 注意 + パーツ毎にインストールすることも可能です。 + + This is what you would probably do once you want to deploy your application to production: + + ``` + pip install fastapi + ``` + + Also install `uvicorn` to work as the server: + + ``` + pip install uvicorn + ``` + + And the same for each of the optional dependencies that you want to use. + +## 高度なユーザーガイド + +**高度なユーザーガイド**もあり、**チュートリアル - ユーザーガイド**の後で読むことができます。 + +**高度なユーザーガイド**は**チュートリアル - ユーザーガイド**に基づいており、同じ概念を使用し、いくつかの追加機能を紹介しています。 + +ただし、最初に**チュートリアル - ユーザーガイド**(現在読んでいる内容)をお読みください。 + +完全なアプリケーションを**チュートリアル-ユーザーガイド**だけで構築し、**高度なユーザーガイド**のアイデアを使用して、ニーズに応じたさまざまな拡張を行えるように設計されています 。 diff --git a/docs/ja/mkdocs.yml b/docs/ja/mkdocs.yml index 8f55ea67c..a960db320 100644 --- a/docs/ja/mkdocs.yml +++ b/docs/ja/mkdocs.yml @@ -25,6 +25,8 @@ nav: - ja: /ja/ - pt: /pt/ - zh: /zh/ +- チュートリアル - ユーザーガイド: + - tutorial/index.md markdown_extensions: - toc: permalink: true