Search Result: ドキュメント

Results of 1 - 10 of about 43 for ドキュメント (0.003 sec.)

メタデータとドキュメントのURL 12818: メタデータとドキュメントのURL FastAPI アプリケーションのいくつかのメタデータの設定をカスタマイズできます。タイトル、説明文、バージョン以下を設定できます: タイトル : OpenAPIおよび自動APIドキュメントUIでAPIのタイトル/名前として使用される。 ... 説明文 : OpenAPIおよび自動APIドキュメントUIでのAPIの説明文。バージョン : APIのバージョン。例: v2 または 2.5.0 。 *たとえば、以前のバージョンのアプリケーションがあり ... NSE-2.0.html" , }, ) @app . get ( "/items/" ) async def read_items (): return [{ "name" : "Katana" }] この設定では、自動APIドキュメントは以下の様になります: タグのためのメタデータさらに、パラメータ openapi_tags を使うと、path operations をグループ分けするため ... の tags パラメーターで使用するのと同じタグ名である str 。 description : タグの簡単な説明文である str 。 Markdownで記述でき、ドキュメントUIに表示されます。 externalDocs : 外部ドキュメントを説明するための dict : description : 外部ドキュメントの簡単な説明文である ...; https://man.mtool.work/fastapi/0.115/tutorial/metadata/

代替ツールから受けたインスピレーションと比較 11461: 代替ツールから受けたインスピレーションと比較何が FastAPI にインスピレーションを与えたのか、他の代替ツールと比較してどうか、そしてそこから何を学んだのかについて。はじめに FastAPI は、代替ツールのこれまでの働きがなければ存在しなかったでしょ ... PIの機能を向上させるために作られました。 Mozilla、Red Hat、Eventbrite など多くの企業で利用されています。これは自動的なAPIドキュメント生成の最初の例であり、これは FastAPI に向けた「調査」を触発した最初のアイデアの一つでした。備考 Django REST Framework は T ... れました。StarletteとUvicornの生みの親であり、 FastAPI のベースとなっています。 FastAPI へ与えたインスピレーション自動でAPIドキュメントを生成するWebユーザーインターフェースを持っている点。 Flask Flask は「マイクロフレームワーク」であり、データベースとの統合の ... メインのデータストレージシステムとしてNoSQLデータベースを使用するといったようなことが可能になります。非常にシンプルなので、ドキュメントはいくつかの点でやや技術的でありますが、比較的直感的に学ぶことができます。また、データベースやユーザ管理、あるいはDjangoにあ ...; https://man.mtool.work/fastapi/0.115/alternatives/

FastAPI 10875: FastAPI FastAPI framework, high performance, easy to learn, fast to code, ready for production ドキュメント : https://fastapi.tiangolo.com ソースコード : https://github.com/fastapi/fastapi FastAPI は、Pythonの標準である型ヒントに基づいてPyt ... ディタのサポートやオートコンプリート。デバッグ時間を削減します。簡単 : 簡単に利用、習得できるようにデザインされています。ドキュメントを読む時間を削減します。短い : コードの重複を最小限にしています。各パラメータからの複数の機能。少ないバグ。堅牢性 : 自動対 ... 話ドキュメントを使用して、本番環境で使用できるコードを取得します。 Standards-based : API のオープンスタンダードに基づいており、完全に互換性 ... ) async def read_item ( item_id : int , q : str = None ): return { "item_id" : item_id , "q" : q } 注 : わからない場合は、 ドキュメントの async と await にある "In a hurry?"セクションをチェックしてください。実行以下のコマンドでサーバーを起動します: $ uvicor ...; https://man.mtool.work/fastapi/0.115/

カスタムレスポンス - HTML、ストリーム、ファイル、その他のレスポンス 10396: カスタムレスポンス - HTML、ストリーム、ファイル、その他のレスポンスデフォルトでは、 FastAPI は JSONResponse を使ってレスポンスを返します。レスポンスを直接返すで見たように、 Response を直接返すことでこの挙動をオーバーライドできます。しか ... し、 Response を直接返すと、データは自動的に変換されず、ドキュメントも自動生成されません (例えば、生成されるOpenAPIの一部としてHTTPヘッダー Content-Type に特定の「メディアタイプ」を含めるなど) ... アタイプを指定せずにレスポンスクラスを利用すると、FastAPIは何もコンテンツがないことを期待します。そのため、生成されるOpenAPIドキュメントにレスポンスフォーマットが記載されません。 ORJSONResponse を使う例えば、パフォーマンスを出したい場合は、 orjson をインストー ... ることもできます。この場合、HTTPヘッダー Content-Type には application/json がセットされます。そして、OpenAPIにはそのようにドキュメントされます。豆知識 ORJSONResponse は、現在はFastAPIのみで利用可能で、Starletteでは利用できません。 HTMLレスポンス FastAPI から ...; https://man.mtool.work/fastapi/0.115/advanced/custom-response/

セキュリティ - 最初の一歩 9533: セキュリティ - 最初の一歩あるドメインに、バックエンド APIを持っているとしましょう。そして、別のドメインか同じドメインの違うパス（またはモバイルアプリケーションの中）にフロントエンドを持っています。さらに、フロントエンドがユーザー名と ... le="color: green;">INFO</span>: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) 確認次のインタラクティブなドキュメントにアクセスしてください: http://127.0.0.1:8000/docs 。下記のように見えるでしょう: Authorizeボタン! すでにピカピカの新しい「A ... から動くようになります。もちろんエンドユーザーのためのフロントエンドではありません。しかし、すべてのAPIをインタラクティブにドキュメント化するための素晴らしい自動ツールです。フロントエンドチームはこれを利用できます (また、あなたも利用できます) 。サードパーテ ... /token はクライアントがトークンを取得するために使用するものであると宣言します。この情報は OpenAPI やインタラクティブな API ドキュメントシステムで使われます。実際のpath operationもすぐに作ります。情報非常に厳格な「Pythonista」であれば、パラメーター名のスタイ ...; https://man.mtool.work/fastapi/0.115/tutorial/security/first-steps/

条件付き OpenAPI 9363: 条件付き OpenAPI 必要であれば、設定と環境変数を利用して、環境に応じて条件付きでOpenAPIを構成することが可能です。また、完全にOpenAPIを無効にすることもできます。セキュリティとAPI、およびドキュメントについて本番環境においてドキュメントのUIを ... ン制御をOAuth2スコープを使って行う。などそれでも、例えば本番環境のような特定の環境のみで、あるいは環境変数の設定によってAPIドキュメントをどうしても無効にしたいという、非常に特殊なユースケースがあるかもしれません。設定と環境変数による条件付き OpenAPI 生成する ... OpenAPIとドキュメントUIの構成は、共通のPydanticの設定を使用して簡単に切り替えられます。例えば、 Python 3.8+ from fastapi import FastAPI from py ... astAPI appを作る際に使います。それから、以下のように OPENAPI_URL という環境変数を空文字列に設定することによってOpenAPI (UIドキュメントを含む) を無効化することができます。 $ OPENAPI_URL = uvicorn main:app <span style="color: green;">INFO</span>: Uvicorn runni ...; https://man.mtool.work/fastapi/0.115/how-to/conditional-openapi/

パスパラメータ 9332: パスパラメータ Pythonのformat文字列と同様のシンタックスで「パスパラメータ」や「パス変数」を宣言できます: Python 3.8+ from fastapi import FastAPI app = FastAPI () @app . get ( "/items/ {item_id} " ) async def read_item ( item_id ): return { ... のある箇所が明確に指摘されていることに注意してください。これは、APIに関連するコードの開発およびデバッグに非常に役立ちます。 ドキュメント そしてブラウザで http://127.0.0.1:8000/docs を開くと、以下の様な自動的に生成された対話的なドキュメントが表示されます。確認 ... 繰り返しになりますが、Python型宣言を使用するだけで、 FastAPI は対話的なAPIドキュメントを自動的に生成します（Swagger UIを統合）。パスパラメータが整数として宣言されていることに注意してください。標準であることの ... た、生成されたスキーマが OpenAPI 標準に従っているので、互換性のあるツールが多数あります。このため、 FastAPI 自体が代替のAPIドキュメントを提供します（ReDocを使用）。これは、 http://127.0.0.1:8000/redoc にアクセスすると確認できます。同様に、互換性のあるツールが ...; https://man.mtool.work/fastapi/0.115/tutorial/path-params/

機能 8993: 機能 FastAPIの機能 FastAPI は以下の機能をもちます: オープンスタンダード準拠 API作成のための OpenAPI 。これは、 path operations の宣言、パラメータ、ボディリクエスト、セキュリティなどを含んでいます。 JSONスキーマを使用したデータモデルのドキュメント ... するのではなく、これらの基準に基づいて設計されました。これにより、多くの言語で自動クライアントコード生成が可能です。自動ドキュメント生成対話的なAPIドキュメントと探索的なwebユーザーインターフェースを提供します。フレームワークはOpenAPIを基にしているため、い ... er UI で、インタラクティブな探索をしながら、ブラウザから直接APIを呼び出してテストが行えます。 ReDoc を使用したもう一つのAPIドキュメント生成。現代的なPython FastAPIの機能はすべて、標準のPython 3.8型宣言に基づいています（Pydanticの功績）。新しい構文はありません ... かになりました。 FastAPI フレームワークは、この要求を満たすことを基本としています。オートコンプリートはどこでも機能します。 ドキュメントに戻る必要はほとんどありません。エディターがどのように役立つかを以下に示します: Visual Studio Code の場合: PyCharm の場合: ...; https://man.mtool.work/fastapi/0.115/features/

静的ファイル 8854: 静的ファイル StaticFiles を使用して、ディレクトリから静的ファイルを自動的に提供できます。 StaticFiles の使用 StaticFiles をインポート。 StaticFiles() インスタンスを生成し、特定のパスに「マウント」。 Python 3.8+ from fastapi import FastAPI f ... これは、マウントされたアプリケーションが完全に独立しているため、 APIRouter とは異なります。メインアプリケーションのOpenAPIとドキュメントには、マウントされたアプリケーションの内容などは含まれません。これについて詳しくは、高度なユーザーガイドをご覧ください。 ... リケーションのニーズと詳細に合わせて調整します。より詳しい情報詳細とオプションについては、 Starletteの静的ファイルに関するドキュメント を確認してください。 ...; https://man.mtool.work/fastapi/0.115/tutorial/static-files/

Pythonの型の紹介 8638: Pythonの型の紹介 Python 3.6以降では「型ヒント」オプションがサポートされています。これらの "型ヒント" は変数の型を宣言することができる新しい構文です。（Python 3.6以降）変数に型を宣言することでエディターやツールがより良いサポートを提供す ... ジェクトを提供してくれます。また、その結果のオブジェクトですべてのエディタのサポートを受けることができます。 Pydanticの公式ドキュメントから引用: Python 3.8+ from datetime import datetime from typing import List , Union from pydantic import BaseModel class Use ... =datetime.datetime(2017, 6, 1, 12, 22) friends=[1, 2, 3] print ( user . id ) # > 123 情報 Pydanticについてより学びたい方は ドキュメントを参照してください . FastAPI はすべてPydanticをベースにしています。すべてのことはチュートリアル - ユーザーガイドで実際に見 ... 必要な型に変換します。データの検証 : リクエストごとに: データが無効な場合にクライアントに返される自動エラーを生成します。 ドキュメント OpenAPIを使用したAPI: 自動的に対話型ドキュメントのユーザーインターフェイスで使用されます。すべてが抽象的に聞こえるかもしれ ...; https://man.mtool.work/fastapi/0.115/python-types/

PREV 1 2 3 4 5 NEXT