Results of 1 - 10 of about 17 for swagger (0.004 sec.)
- Custom Docs UI Static Assets (Self-Hosting) 13604
- Custom Docs UI Static Assets (Self-Hosting) Warning The current page still doesn't have a translation for this language. But you can help translating it: Contributing . The API docs use Swagger UI and ReDoc , and each of those need some Jav
...creating your FastAPI app: Python 3.8+ from fastapi import FastAPI from fastapi.openapi.docs import ( get_redoc_html , get_swagger_ui_html , get_swagger_ui_oauth2_redirect_html , ) app = FastAPI ( docs_url = None , redoc_url = None ) @app . get ( "/docs..." , include_in_schema = False ) async def custom_swagger_ui_html (): return get_swagger_ui_html ( openapi_url = app . openapi_url , title = app . title + " - Swagger UI" , oauth2_...redirect_url = app . swagger_ui_oauth2_redirect_url , swagger_js_url = "https://unpkg.com/swagger-ui-dist@5/swagger-ui-bundle.js" , swagger_css_url = "... - https://man.mtool.work/fastapi/0.115/how-to/custom-docs-ui-assets/
- Configure Swagger UI 12673
- Configure Swagger UI Warning The current page still doesn't have a translation for this language. But you can help translating it: Contributing . You can configure some extra Swagger UI parameters . To configure them, pass the swagger_ui_pa
...rameters argument when creating the FastAPI() app object or to the get_swagger_ui_html() function. swagger_ui_parameters receives a dictionary with the configurations passed to Swagger UI directly. Fas...tAPI converts the configurations to JSON to make them compatible with JavaScript, as that's what Swagger UI needs. Disable Syntax Highlighting For example, you could disable syntax highlighting in Swagger UI. Without changing t...ault: But you can disable it by setting syntaxHighlight to False : Python 3.8+ from fastapi import FastAPI app = FastAPI ( swagger_ui_parameters = { "syntaxHighlight" : False }) @app . get ( "/users/ {username} " ) async def read_user ( username : str )... - https://man.mtool.work/fastapi/0.115/how-to/configure-swagger-ui/
- OpenAPI docs 9724
- OpenAPI docs Utilities to handle OpenAPI automatic UI documentation, including Swagger UI (by default at /docs ) and ReDoc (by default at /redoc ). ::: fastapi.openapi.docs.get_swagger_ui_html ::: fastapi.openapi.docs.get_redoc_html ::: fas
...tapi.openapi.docs.get_swagger_ui_oauth2_redirect_html ::: fastapi.openapi.docs.swagger_ui_default_parameters... - https://man.mtool.work/fastapi/0.115/reference/openapi/docs/
- 代替ツールから受けたインスピレーションと比較 8379
- 代替ツールから受けたインスピレーションと比較 何が FastAPI にインスピレーションを与えたのか、他の代替ツールと比較してどうか、そしてそこから何を学んだのかについて。 はじめに FastAPI は、代替ツールのこれまでの働きがなければ存在しなかったでしょ
...ている点。 HTTPメソッド名を直接利用し、単純で直感的である。 適切なデフォルト値を持ちつつ、強力なカスタマイズ性を持っている。 Swagger / OpenAPI 私がDjango REST Frameworkに求めていた主な機能は、APIの自動的なドキュメント生成でした。 そして、Swaggerと呼ばれる...、 JSON (またはYAML、JSONの拡張版) を使ってAPIをドキュメント化するための標準があることを知りました。 そして、Swagger API用のWebユーザーインターフェースが既に作成されていました。つまり、API用のSwaggerドキュメントを生成することができれば、こ...のWebユーザーインターフェースを自動的に使用することができるようになります。 ある時点で、SwaggerはLinux Foundationに寄贈され、OpenAPIに改名されました。 そのため、バージョン2.0では「Swagger」、バージョン3以上では「OpenAPI... - https://man.mtool.work/fastapi/0.115/alternatives/
- Release Notes 8224
- Release Notes Latest Changes 0.115.11 Fixes ? Add docs examples and tests (support) for Annotated custom validations, like AfterValidator , revert #13440 . PR #13442 by @tiangolo . New docs: Query Parameters and String Validations - Custom
...s. PR #13329 by @svlandeg . ? Fix typos in virtual environments documentation. PR #13396 by @bullet-ant . ? Fix issue with Swagger theme change example in the official tutorial. PR #13289 by @Zerohertz . ? Add more precise description of HTTP status cod...r docs/ko/docs/resources/index.md . PR #13004 by @hard-coders . ? Add Korean translation for docs/ko/docs/how-to/configure-swagger-ui.md . PR #12898 by @nahyunkeem . ? Add Korean translation to docs/ko/docs/advanced/additional-status-codes.md . PR #1271...s in docs/fr/docs/tutorial/path-params.md . PR #12592 by @kantandane . ? Update includes for docs/de/docs/how-to/configure-swagger-ui.md . PR #12690 by @alissadb . ? Update includes in docs/en/docs/advanced/security/oauth2-scopes.md . PR #12572 by @kris... - https://man.mtool.work/fastapi/0.115/release-notes/
- FastAPI 7983
- 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 のオープンスタンダードに基づいており、完全に互換性があります: OpenAPI (以前は Swagger として知られていました) や JSON スキーマ . * 本番アプリケーションを構築している開発チームのテストによる見積もり。 Sponsors...の API ドキュメント http://127.0.0.1:8000/docs にアクセスしてみてください。 自動対話型の API ドキュメントが表示されます。 ( Swagger UI が提供しています。): 代替の API ドキュメント http://127.0.0.1:8000/redoc にアクセスしてみてください。 代替の自動ドキュメ...オブジェクト データベースモデル ...などなど 2 つの代替ユーザーインターフェースを含む自動インタラクティブ API ドキュメント: Swagger UI. ReDoc. コード例に戻りましょう、 FastAPI は次のようになります: GET および PUT リクエストのパスに item_id があることを検... - https://man.mtool.work/fastapi/0.115/
- メタデータとドキュメントのURL 7983
- メタデータとドキュメントのURL FastAPI アプリケーションのいくつかのメタデータの設定をカスタマイズできます。 タイトル、説明文、バージョン 以下を設定できます: タイトル : OpenAPIおよび自動APIドキュメントUIでAPIのタイトル/名前として使用される。
...ます。これにより、それを使用するドキュメントUIも無効になります。 ドキュメントのURL 以下の2つのドキュメントUIを構築できます: Swagger UI : /docs で提供されます。 URL はパラメータ docs_url で設定できます。 docs_url=None を設定することで無効にできます。 ReDo...す。 URL はパラメータ redoc_url で設定できます。 redoc_url=None を設定することで無効にできます。 たとえば、 /documentation でSwagger UIが提供されるように設定し、ReDocを無効にするには: Python 3.8+ from fastapi import FastAPI app = FastAPI ( docs_url = "/do... - https://man.mtool.work/fastapi/0.115/tutorial/metadata/
- Generate Clients 7897
- Generate Clients Warning The current page still doesn't have a translation for this language. But you can help translating it: Contributing . As FastAPI is based on the OpenAPI specification, you get automatic compatibility with many tools,
...including the automatic API docs (provided by Swagger UI). One particular advantage that is not necessarily obvious is that you can generate clients (sometimes called SDKs ) fo...with the models in the app. That information is available in the app's OpenAPI schema , and then shown in the API docs (by Swagger UI). And that same information from the models that is included in OpenAPI is what can be used to generate the client code... - https://man.mtool.work/fastapi/0.115/advanced/generate-clients/
- スキーマの追加 - 例 7810
- スキーマの追加 - 例 JSON Schemaに追加する情報を定義することができます。 一般的なユースケースはこのドキュメントで示されているように example を追加することです。 JSON Schemaの追加情報を宣言する方法はいくつかあります。 Pydanticの schema_extra
...す。 そのため、OpenAPIでは同じ目的のために example を独自に定義しており（ examples ではなく example として）、それがdocs UI（Swagger UIを使用）で使用されています。 つまり、 example はJSON Schemaの一部ではありませんが、OpenAPIの一部であり、それがdocs UIで使... - https://man.mtool.work/fastapi/0.115/tutorial/schema-extra-example/
- セキュリティ入門 7810
- セキュリティ入門 セキュリティ、認証、認可を扱うには多くの方法があります。 そして、通常、それは複雑で「難しい」トピックです。 多くのフレームワークやシステムでは、セキュリティと認証を処理するだけで、膨大な労力とコードが必要になります（多くの場
...た。 つまり、完全な追加システムだったのです。 現在ではあまり普及していませんし、使われてもいません。 OpenAPI OpenAPI（以前はSwaggerとして知られていました）は、APIを構築するためのオープンな仕様です（現在はLinux Foundationの一部になっています）。 FastAPI は... - https://man.mtool.work/fastapi/0.115/tutorial/security/