Results of 1 - 10 of about 51 for Docs (0.005 sec.)
- Release Notes 14087
- 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
...Validation . Translations ? Add Russian translation for docs/ru/docs/tutorial/middleware.md . PR #13412 by @alv2017 . Internal ? Update FastAPI GitHub topic repositories. PR #13439 by...ette to allow up to 0.46.0: >=0.40.0,<0.47.0 . PR #13426 by @musicinmybrain . Translations ? Add Ukrainian translation for docs/uk/docs/tutorial/debugging.md . PR #13370 by @valentinDruzhinin . ? Add Ukrainian translation for docs/uk/docs/tutorial/qu...ery-params.md . PR #13362 by @valentinDruzhinin . ? Add Ukrainian translation for docs/uk/docs/tutorial/path-params.md . PR #13354 by @valentinDruzhinin . ? Add Japanese translation for docs/ja/docs/tutorial/c... - https://man.mtool.work/fastapi/0.115/release-notes/
- General - How To - Recipes 11150
- 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
.... Filter Data - Security To ensure that you don't return more data than you should, read the docs for Tutorial - Response Model - Return Type . Documentation Tags - OpenAPI To add tags to your path operations , 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 the docs for Tutorial - Path Operation Configurations - Summary and Description . Documentation Response descript... - https://man.mtool.work/fastapi/0.115/how-to/general/
- Development - Contributing 10940
- Development - Contributing Warning The current page still doesn't have a translation for this language. But you can help translating it: Contributing . First, you might want to see the basic ways to help FastAPI and get help . Developing If
...ou can explore interactively the regions of code that are covered by the tests, and notice if there is any region missing. Docs First, make sure you set up your environment as described above, that will install all the requirements. Docs live During...local development, there is a script that builds the site and checks for any changes, live-reloading: $ python ./scripts/docs.py live <span style="color: green;">[INFO]</span> Serving on http://127.0.0.1:8008 <span style="color: green;">[INFO]</spa...Tip Alternatively, you can perform the same steps that scripts does manually. Go into the language directory, for the main docs in English it's at docs/en/ : $ cd docs/en/ Then run mkdocs in that directory: $ mkdocs serve --dev-addr 127 .0.0.1:8008 T... - https://man.mtool.work/fastapi/0.115/contributing/
- Custom Docs UI Static Assets (Self-Hosting) 10910
- 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
...s://unpkg.com/ . This could be useful if for example you live in a country that restricts some URLs. Disable the automatic docs The first step is to disable the automatic docs, as by default, those use the default CDN. To disable them, set their URLs...to None when 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 . opena... - https://man.mtool.work/fastapi/0.115/how-to/custom-docs-ui-assets/
- Repository Management Tasks 10401
- 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
...e ? and then Add {language} translation for and then the translated file path. For example: ? Add Spanish translation for `docs/es/docs/teleporting.md` Once the PR is merged, a GitHub Action ( latest-changes ) will use the PR title to update the late...in their code base once they update. But this is not for upgrades to internal dependencies used for development, testing, docs, etc. Those internal dependencies, normally in requirements.txt files or GitHub Action versions should be marked as intern...al , not upgrade . docs : Docs Changes in docs. This includes updating the docs, fixing typos. But it doesn't include changes to translations. You... - https://man.mtool.work/fastapi/0.115/management-tasks/
- OpenAPI docs 9591
- 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/
- Sub Applications - Mounts 8797
- Sub Applications - Mounts Warning The current page still doesn't have a translation for this language. But you can help translating it: Contributing . If you need to have two independent FastAPI applications, with their own independent Open
...API and their own docs UIs, you can have a main app and "mount" one (or more) sub-application(s). Mounting a FastAPI application "Mounting" means...read_sub (): return { "message" : "Hello World from sub API" } app . mount ( "/subapi" , subapi ) Check the automatic API docs Now, run the fastapi command with your file: $ fastapi dev main.py <span style="color: green;">INFO</span>: Uvicorn runnin...g on http://127.0.0.1:8000 (Press CTRL+C to quit) And open the docs at http://127.0.0.1:8000/docs . You will see the automatic API docs for the main app, including only its own path operatio... - https://man.mtool.work/fastapi/0.115/advanced/sub-applications/
- Configure Swagger UI 8198
- 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
...pi.encoders import jsonable_encoder from starlette.responses import HTMLResponse from typing_extensions import Annotated , Doc swagger_ui_default_parameters : Annotated [ Dict [ str , Any ], Doc ( """ Default configurations for Swagger UI. You can us...Any ]], Doc ( """ Configuration parameters for Swagger UI. It defaults to [swagger_ui_default_parameters][fastapi.openapi.docs.swagger_ui_default_parameters]. """ ), ] = None , ) -> HTMLResponse : """ Generate and return the HTML that loads Swagger...UI for the interactive API docs (normally served at `/docs`). You would only call this function yourself if you needed to override some parts, for example... - https://man.mtool.work/fastapi/0.115/how-to/configure-swagger-ui/
- Behind a Proxy 8138
- Behind a Proxy Warning The current page still doesn't have a translation for this language. But you can help translating it: Contributing . In some situations, you might need to use a proxy server like Traefik or Nginx with a configuration
...code to include the prefix /api/v1 . Up to here, everything would work as normally. But then, when you open the integrated docs UI (the frontend), it would expect to get the OpenAPI schema at /openapi.json , instead of /api/v1/openapi.json . So, the...Tip The IP 0.0.0.0 is commonly used to mean that the program listens on all the IPs available in that machine/server. The docs UI would also need the OpenAPI schema to declare that this API server is located at /api/v1 (behind the proxy). For exampl...oxy (Traefik) uses the path prefix and how the server (Uvicorn) uses the root_path from the option --root-path . Check the docs UI But here's the fun part. ✨ The "official" way to access the app would be through the proxy with the path prefix that we... - https://man.mtool.work/fastapi/0.115/advanced/behind-a-proxy/
- メタデータとドキュメントのURL 7808
- メタデータとドキュメントのURL FastAPI アプリケーションのいくつかのメタデータの設定をカスタマイズできます。 タイトル、説明文、バージョン 以下を設定できます: タイトル : OpenAPIおよび自動APIドキュメントUIでAPIのタイトル/名前として使用される。
...タグ名である str 。 description : タグの簡単な説明文である str 。 Markdownで記述でき、ドキュメントUIに表示されます。 externalDocs : 外部ドキュメントを説明するための dict : description : 外部ドキュメントの簡単な説明文である str 。 url ( 必須 ): 外部ドキ...The **login** logic is also here." , }, { "name" : "items" , "description" : "Manage items. So _fancy_ they have their own docs." , "externalDocs" : { "description" : "Items external docs" , "url" : "https://fastapi.tiangolo.com/" , }, }, ] app = Fas...The **login** logic is also here." , }, { "name" : "items" , "description" : "Manage items. So _fancy_ they have their own docs." , "externalDocs" : { "description" : "Items external docs" , "url" : "https://fastapi.tiangolo.com/" , }, }, ] app = Fas... - https://man.mtool.work/fastapi/0.115/tutorial/metadata/