Results of 1 - 9 of about 9 for Summary (0.003 sec.)
- Extending OpenAPI 12115
- Extending OpenAPI Warning The current page still doesn't have a translation for this language. But you can help translating it: Contributing . There are some cases where you might need to modify the generated OpenAPI schema. In this section
...of your API, e.g. 2.5.0 . openapi_version : The version of the OpenAPI specification used. By default, the latest: 3.1.0 . summary : A short summary of the API. description : The description of your API, this can include markdown and will be shown in th...: A list of routes, these are each of the registered path operations . They are taken from app.routes . Info The parameter summary is available in OpenAPI 3.1.0 and above, supported by FastAPI 0.99.0 and above. Overriding the defaults Using the informat.... openapi_schema : return app . openapi_schema openapi_schema = get_openapi ( title = "Custom title" , version = "2.5.0" , summary = "This is a very custom OpenAPI schema" , description = "Here's a longer description of the custom **OpenAPI** schema" ,... - https://man.mtool.work/fastapi/0.115/how-to/extending-openapi/
- Path Operationの設定 11540
- Path Operationの設定 path operationデコレータ を設定するためのパラメータがいくつかあります。 注意 これらのパラメータは path operation関数 ではなく、 path operationデコレータ に直接渡されることに注意してください。 レスポンスステータスコード
..."username" : "johndoe" }] これらはOpenAPIスキーマに追加され、自動ドキュメントのインターフェースで使用されます: 概要と説明 summary と description を追加できます: Python 3.8+ from typing import Set , Union from fastapi import FastAPI from pydantic import...: float tax : Union [ float , None ] = None tags : Set [ str ] = set () @app . post ( "/items/" , response_model = Item , summary = "Create an item" , description = "Create an item with all the information, name, description, price, tax and a set of un...None price : float tax : float | None = None tags : set [ str ] = set () @app . post ( "/items/" , response_model = Item , summary = "Create an item" , description = "Create an item with all the information, name, description, price, tax and a set of un... - https://man.mtool.work/fastapi/0.115/tutorial/path-operation-configuration/
- General - How To - Recipes 10749
- General - How To - Recipes Warning The current page still doesn't have a translation for this language. But you can help translating it: Contributing . Here are several pointers to other places in the docs, for general or frequent questions
...rations , and group them in the docs UI, read the docs for Tutorial - Path Operation Configurations - Tags . Documentation Summary and Description - OpenAPI To add a summary and description to your path operations , and show them in the docs UI, read th...e docs for Tutorial - Path Operation Configurations - Summary and Description . Documentation Response description - OpenAPI To define the description of the response, shown in the doc... - https://man.mtool.work/fastapi/0.115/how-to/general/
- Form Models 8016
- Form Models Warning The current page still doesn't have a translation for this language. But you can help translating it: Contributing . You can use Pydantic models to declare form fields in FastAPI. Info To use forms, first install python-
..._forbidden" , "loc" : [ "body" , "extra" ], "msg" : "Extra inputs are not permitted" , "input" : "Mr. Poopybutthole" } ] } Summary You can use Pydantic models to declare form fields in FastAPI. ?... - https://man.mtool.work/fastapi/0.115/tutorial/request-form-models/
- Path Operationの高度な設定 7909
- Path Operationの高度な設定 OpenAPI operationId 注意 あなたがOpenAPIの「エキスパート」でなければ、これは必要ないかもしれません。 path operation で operation_id パラメータを利用することで、OpenAPIの operationId を設定できます。 operation_id は
...: float tax : Union [ float , None ] = None tags : Set [ str ] = set () @app . post ( "/items/" , response_model = Item , summary = "Create an item" ) async def create_item ( item : Item ): """ Create an item with all the information: - **name**: each... - https://man.mtool.work/fastapi/0.115/advanced/path-operation-advanced-configurat...
- Header Parameter Models 7819
- Header Parameter Models Warning The current page still doesn't have a translation for this language. But you can help translating it: Contributing . If you have a group of related header parameters , you can create a Pydantic model to decla
..."extra_forbidden" , "loc" : [ "header" , "tool" ], "msg" : "Extra inputs are not permitted" , "input" : "plumbus" , } ] } Summary You can use Pydantic models to declare headers in FastAPI . ?... - https://man.mtool.work/fastapi/0.115/tutorial/header-param-models/
- メタデータとドキュメントのURL 7711
- メタデータとドキュメントのURL FastAPI アプリケーションのいくつかのメタデータの設定をカスタマイズできます。 タイトル、説明文、バージョン 以下を設定できます: タイトル : OpenAPIおよび自動APIドキュメントUIでAPIのタイトル/名前として使用される。
...emented_). * **Read users** (_not implemented_). """ app = FastAPI ( title = "ChimichangApp" , description = description , summary = "Deadpool's favorite app. Nuff said." , version = "0.0.1" , terms_of_service = "http://example.com/terms/" , contact = {... - https://man.mtool.work/fastapi/0.115/tutorial/metadata/
- Repository Management Tasks 7621
- Repository Management Tasks These are the tasks that can be performed to manage the FastAPI repository by team members . Tip This section is useful only to a handful of people, team members with permissions to manage the repository. You can
...it's modifying requirements.txt files, or GitHub Action versions, if the tests are passing, the release notes (shown in a summary in the PR) don't show any obvious potential breaking change, you can merge it. ? Mark GitHub Discussions Answers When a qu... - https://man.mtool.work/fastapi/0.115/management-tasks/
- Release Notes 7333
- 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
...dd support for pip install "fastapi[standard]" with standard dependencies and python -m fastapi . PR #11935 by @tiangolo . Summary Install with: pip install "fastapi[standard]" Other Changes This adds support for calling the CLI as: python -m fastapi An... - https://man.mtool.work/fastapi/0.115/release-notes/
PREV
1
NEXT