fastapi changelog

Changelog History

Page 1

• v0.62.0 Changes

  November 29, 2020

  🔋 Features

  • 🍱 ✨ Add support for shared/top-level parameters (dependencies, tags, etc). PR #2434 by @tiangolo.

  Up to now, for several options, the only way to apply them to a group of path operations was in include_router. That works well, but the call to app.include_router() or router.include_router() is normally done in another file.

  That means that, for example, to apply authentication to all the path operations in a router it would end up being done in a different file, instead of keeping related logic together.

  🔧 Setting options in include_router still makes sense in some cases, for example, to override or increase configurations from a third party router included in an app. But in a router that is part of a bigger application, it would probably make more sense to add those settings when creating the APIRouter.

  In FastAPI

  This allows setting the (mostly new) parameters (additionally to the already existing parameters):

  • default_response_class: updated to handle defaults in APIRouter and include_router.
  • 🍱 dependencies: to include ✨ top-level dependencies ✨ that apply to the whole application. E.g. to add global authentication.
  • callbacks: OpenAPI callbacks that apply to all the path operations.
  • deprecated: to mark all the path operations as deprecated. 🤷
  • include_in_schema: to allow excluding all the path operations from the OpenAPI schema.
  • responses: OpenAPI responses that apply to all the path operations.

  For example:

  from fastapi import FastAPI, Dependsasync def some\_dependency(): returnapp = FastAPI(dependencies=[Depends(some\_dependency)])
  

  In APIRouter

  This allows setting the (mostly new) parameters (additionally to the already existing parameters):

  • default_response_class: updated to handle defaults in APIRouter and include_router. For example, it's not needed to set it explicitly when creating callbacks.
  • dependencies: to include ✨ router-level dependencies ✨ that apply to all the path operations in a router. Up to now, this was only possible with include_router.
  • callbacks: OpenAPI callbacks that apply to all the path operations in this router.
  • deprecated: to mark all the path operations in a router as deprecated.
  • include_in_schema: to allow excluding all the path operations in a router from the OpenAPI schema.
  • responses: OpenAPI responses that apply to all the path operations in a router.
  • prefix: to set the path prefix for a router. Up to now, this was only possible when calling include_router.
  • tags: OpenAPI tags to apply to all the path operations in this router.

  For example:

  from fastapi import APIRouter, Dependsasync def some\_dependency(): returnrouter = APIRouter(prefix="/users", dependencies=[Depends(some\_dependency)])
  

  In include_router

  👍 Most of these settings are now supported in APIRouter, which normally lives closer to the related code, so it is recommended to use APIRouter when possible.

  But include_router is still useful to, for example, adding options (like dependencies, prefix, and tags) when including a third party router, or a generic router that is shared between several projects.

  This PR allows setting the (mostly new) parameters (additionally to the already existing parameters):

  • default_response_class: updated to handle defaults in APIRouter and FastAPI.
  • deprecated: to mark all the path operations in a router as deprecated in OpenAPI.
  • include_in_schema: to allow disabling all the path operations from showing in the OpenAPI schema.
  • callbacks: OpenAPI callbacks that apply to all the path operations in this router.

  Note: all the previous parameters are still there, so it's still possible to declare dependencies in include_router.

  💥 Breaking Changes

  • PR #2434 includes several improvements that shouldn't affect normal use cases, but could affect in advanced scenarios:
    • If you are testing the generated OpenAPI (you shouldn't, FastAPI already tests it extensively for you): the order for tags in include_router and path operations was updated for consistency, but it's a simple order change.
    • If you have advanced custom logic to access each route's route.response_class, or the router.default_response_class, or the app.default_response_class: the default value for response_class in APIRoute and for default_response_class in APIRouter and FastAPI is now a DefaultPlaceholder used internally to handle and solve default values and overrides. The actual response class inside the DefaultPlaceholder is available at route.response_class.value.

  📄 Docs

  ⚡️ PR #2434 (above) includes new or updated docs:

  • Advanced User Guide - OpenAPI Callbacks.
  • Tutorial - Bigger Applications.
  • Tutorial - Dependencies - Dependencies in path operation decorators.

  - Tutorial - Dependencies - Global Dependencies.

  🍱 📝 Add FastAPI monitoring blog post to External Links. PR #2324 by @louisguitton.

  🍱 ✏️ Fix typo in Deta tutorial. PR #2320 by @tiangolo.

  🍱 ✨ Add Discord chat. PR #2322 by @tiangolo.

  🍱 📝 Fix image links for sponsors. PR #2304 by @tiangolo.

  🌐 Translations

  • 🌐 Add Japanese translation for Advanced - Custom Response. PR #2193 by @Attsun1031.
  • 🌐 Add Chinese translation for Benchmarks. PR #2119 by @spaceack.
  • 🌐 Add Chinese translation for Tutorial - Body - Nested Models. PR #1609 by @waynerv.
  • 🌐 Add Chinese translation for Advanced - Custom Response. PR #1459 by @RunningIkkyu.
  • 🌐 Add Chinese translation for Advanced - Return a Response Directly. PR #1452 by @RunningIkkyu.
  • 🌐 Add Chinese translation for Advanced - Additional Status Codes. PR #1451 by @RunningIkkyu.
  • 🌐 Add Chinese translation for Advanced - Path Operation Advanced Configuration. PR #1447 by @RunningIkkyu.
  • 🌐 Add Chinese translation for Advanced User Guide - Intro. PR #1445 by @RunningIkkyu.

  Internal

  • ⚡️ 🔧 Update TestDriven link to course in sponsors section. PR #2435 by @tiangolo.
  • ⚡️ 🍱 Update sponsor logos. PR #2418 by @tiangolo.
  • 🍱 💚 Fix disabling install of Material for MkDocs Insiders in forks, strike 1 ⚾. PR #2340 by @tiangolo.
  • 🍱 🐛 Fix disabling Material for MkDocs Insiders install in forks. PR #2339 by @tiangolo.
  • 🍱 ✨ Add silver sponsor WeTransfer. PR #2338 by @tiangolo.
  • 🍱 ✨ Set up and enable Material for MkDocs Insiders for the docs. PR #2325 by @tiangolo.

• v0.61.2 Changes

  November 05, 2020

  🛠 Fixes

  • 🍱 📌 Relax Swagger UI version pin. PR #2089 by @jmriebold.
  • 🍱 🐛 Fix bug overriding custom HTTPException and RequestValidationError from exception_handlers. PR #1924 by @uriyyo.
  • 🍱 ✏️ Fix typo on dependencies utils and cleanup unused variable. PR #1912 by @Kludex.

  📄 Docs

  • 🍱 ✏️ Fix typo in Tutorial - Path Parameters. PR #2231 by @mariacamilagl.
  • 🍱 ✏ Fix a stylistic error in docs. PR #2206 by @ddobrinskiy.
  • 🍱 ✏ Fix capitalizaiton typo in docs. PR #2204 by @imba-tjd.
  • 🍱 ✏ Fix typo in docs. PR #2179 by @ammarasmro.
  • ⚡️ 📝 Update/fix links in docs to use HTTPS. PR #2165 by @imba-tjd.
  • 🍱 ✏ Fix typos and add rewording in docs. PR #2159 by @nukopy.
  • 🍱 📝 Fix code consistency in examples for Tutorial - User Guide - Path Parameters. PR #2158 by @nukopy.
  • 🍱 📝 Fix renamed parameter content_type typo. PR #2135 by @TeoZosa.
  • 🍱 ✏ Fix minor typos in docs. PR #2122 by @TeoZosa.
  • 🍱 ✏ Fix typos in docs and source examples. PR #2102 by @AdrianDeAnda.
  • 🍱 ✏ Fix incorrect Celery URLs in docs. PR #2100 by @CircleOnCircles.
  • 🍱 📝 Simplify intro to Python Types, all currently supported Python versions include type hints 🎉. PR #2085 by @ninjaaron.
  • 🍱 📝 Fix example code with sets in Tutorial - Body - Nested Models 3. PR #2054 by @hitrust.
  • 🍱 📝 Fix example code with sets in Tutorial - Body - Nested Models 2. PR #2053 by @hitrust.
  • 🍱 📝 Fix example code with sets in Tutorial - Body - Nested Models. PR #2052 by @hitrust.
  • 🍱 ✏ Fix typo in Benchmarks. PR #1995 by @AlejoAsd.
  • 📝 Add note in CORS tutorial about allow_origins with ["*"] and allow_credentials. PR #1895 by @dsmurrell.
  • 🚀 📝 Add deployment to Deta, the first gold sponsor 🎉. PR #2303 by @tiangolo.
  • 👥 Update FastAPI People. PR #2282 by @github-actions[bot].
  • 🍱 ✏️ Fix uppercase in Tutorial - Query parameters. PR #2245 by @mariacamilagl.
  • 🍱 📝 Add articles to External Links. PR #2247 by @tiangolo.
  • 🍱 ✏ Fix typo in Spanish tutorial index. PR #2020 by @aviloncho.

  🌐 Translations

  • 🌐 Add Japanese translation for Advanced Tutorial - Response Directly. PR #2191 by @Attsun1031.
  • 🔒 📝 Add Japanese translation for Tutorial - Security - First Steps. PR #2153 by @komtaki.
  • 🌐 Add Japanese translation for Tutorial - Query Parameters and String Validations. PR #1901 by @SwftAlpc.
  • 🌐 Add Portuguese translation for External Links. PR #1443 by @Serrones.
  • 🌐 Add Japanese translation for Tutorial - CORS. PR #2125 by @tokusumi.
  • 🌐 Add Japanese translation for Contributing. PR #2067 by @komtaki.
  • 🌐 Add Japanese translation for Project Generation. PR #2050 by @tokusumi.
  • 🌐 Add Japanese translation for Alternatives. PR #2043 by @Attsun1031.
  • 🌐 Add Japanese translation for History Design and Future. PR #2002 by @komtaki.
  • 🌐 Add Japanese translation for Benchmarks. PR #1992 by @komtaki.
  • 🌐 Add Japanese translation for Tutorial - Header Parameters. PR #1935 by @SwftAlpc.
  • 🌐 Add Portuguese translation for Tutorial - First Steps. PR #1861 by @jessicapaz.
  • 🌐 Add Portuguese translation for Python Types. PR #1796 by @izaguerreiro.
  • 🌐 Add Japanese translation for Help FastAPI. PR #1692 by @tokusumi.
  • 🌐 Add Japanese translation for Tutorial - Body. PR #1683 by @tokusumi.
  • 🌐 Add Japanese translation for Tutorial - Query Params. PR #1674 by @tokusumi.
  • 🌐 Add Japanese translation for tutorial/path-params.md. PR #1671 by @tokusumi.
  • 🌐 Add Japanese translation for tutorial/first-steps.md. PR #1658 by @tokusumi.
  • 🌐 Add Japanese translation for tutorial/index.md. PR #1656 by @tokusumi.
  • 🌐 Add translation to Portuguese for Project Generation. PR #1602 by @Serrones.
  • 🌐 Add Japanese translation for Features. PR #1625 by @tokusumi.
  • 🌐 Initialize new language Korean for translations. PR #2018 by @hard-coders.
  • 🌐 Add Portuguese translation of Deployment. PR #1374 by @Serrones.

  Internal

  • ⬆️ 🔥 Cleanup after upgrade for Docs Previews GitHub Action. PR #2248 by @tiangolo.
  • 👷 🐛 Fix CI docs preview, unzip docs. PR #2246 by @tiangolo.
  • 🚀 ✨ Add instant docs deploy previews for PRs from forks. PR #2244 by @tiangolo.
  • 🏗 ⚡️ Build docs for languages in parallel in subprocesses to speed up CI. PR #2242 by @tiangolo.
  • 🌐 🐛 Fix docs order generation for partial translations. PR #2238 by @tiangolo.
  • 👥 Update FastAPI People. PR #2202 by @github-actions[bot].
  • ⚡️ ♻️ Update FastAPI People GitHub Action to send the PR as github-actions. PR #2201 by @tiangolo.
  • ⚡️ 🔧 Update FastAPI People GitHub Action config, run monthly. PR #2199 by @tiangolo.
  • 🐳 🐛 Fix FastAPI People GitHub Action Docker dependency, strike 1 ⚾. PR #2198 by @tiangolo.
  • 🐳 🐛 Fix FastAPI People GitHub Action Docker dependencies. PR #2197 by @tiangolo.
  • 🍱 🐛 Fix FastAPI People GitHub Action when there's nothing to change. PR #2196 by @tiangolo.
  • 👥 Add new section FastAPI People. PR #2195 by @tiangolo.
  • ⬆️ ⬆️ Upgrade GitHub Action Latest Changes. PR #2190 by @tiangolo.
  • ⬆️ ⬆️ Upgrade GitHub Action Label Approved. PR #2189 by @tiangolo.
  • ⚡️ 🔧 Update GitHub Action Label Approved, run at 12:00. PR #2185 by @tiangolo.
  • ⬆️ 👷 Upgrade GitHub Action Latest Changes. PR #2184 by @tiangolo.
  • 🍱 👷 Set GitHub Action Label Approved to run daily, not every minute. PR #2163 by @tiangolo.
  • 🍱 🔥 Remove pr-approvals GitHub Action as it's not compatible with forks. Use the new one. PR #2162 by @tiangolo.
  • 🍱 👷 Add GitHub Action Latest Changes. PR #2160.
  • 🍱 👷 Add GitHub Action Label Approved. PR #2161.

• v0.61.1 Changes

  August 29, 2020

  🛠 Fixes

  • 🛠 Fix issues using jsonable_encoder with SQLAlchemy models directly. PR #1987.

  📄 Docs

  • 🛠 Fix typo in NoSQL docs. PR #1980 by @facundojmaero.

  🌐 Translations

  • ➕ Add translation for main page to Japanese PR #1571 by @ryuckel.
  • 🎉 Initialize French translations. PR #1975 by @JulianMaurin-BM.
  • 🎉 Initialize Turkish translations. PR #1905 by @ycd.

  Internal

  • 👌 Improve docs maintainability by updating hl_lines syntax to use ranges. PR #1863 by @la-mar.

• v0.61.0 Changes

  August 09, 2020

  🔋 Features

  • ➕ Add support for injecting HTTPConnection (as Request and WebSocket). Useful for sharing app state in dependencies. PR #1827 by @nsidnev.
  • 📄 Export WebSocketDisconnect and add example handling WebSocket disconnections to docs. PR #1822 by @rkbeatss.

  💥 Breaking Changes

  • Require Pydantic > 1.0.0.
    • Remove support for deprecated Pydantic 0.32.2. This improves maintainability and allows new features.
    • In FastAPI and APIRouter:
    • Remove path operation decorators related/deprecated parameter response_model_skip_defaults (use response_model_exclude_unset instead).
    • Change path operation decorators parameter default for response_model_exclude from set() to None (as is in Pydantic).
    • In encoders.jsonable_encoder:
    • Remove deprecated skip_defaults, use instead exclude_unset.
    • Set default of exclude from set() to None (as is in Pydantic).
    • PR #1862.
  • 🚚 In encoders.jsonable_encoder remove parameter sqlalchemy_safe.
    • It was an early hack to allow returning SQLAlchemy models, but it was never documented, and the recommended way is using Pydantic's orm_mode as described in the tutorial: SQL (Relational) Databases.
    • PR #1864.

  📄 Docs

  • ➕ Add link to the course by TestDriven.io: Test-Driven Development with FastAPI and Docker. PR #1860.
  • 🛠 Fix empty log message in docs example about handling errors. PR #1815 by @manlix.
  • Reword text to reduce ambiguity while not being gender-specific. PR #1824 by @Mause.

  Internal

  • ➕ Add Flake8 linting. Original PR #1774 by @MashhadiNima.
  • Disable Gitter bot, as it's currently broken, and Gitter's response doesn't show the problem. PR #1853.

• v0.60.2 Changes

  August 08, 2020

  • 🛠 Fix typo in docs for query parameters. PR #1832 by @ycd.
  • ➕ Add docs about Async Tests. PR #1619 by @empicano.
  • 👻 Raise an exception when using form data (Form, File) without having python-multipart installed.
    • Up to now the application would run, and raise an exception only when receiving a request with form data, the new behavior, raising early, will prevent from deploying applications with broken dependencies.
    • It also detects if the correct package python-multipart is installed instead of the incorrect multipart (both importable as multipart).
    • PR #1851 based on original PR #1627 by @chrisngyn, @YKo20010, @kx-chen.
  • 🚀 Re-enable Gitter releases bot. PR #1831.
  • ➕ Add link to async SQL databases tutorial from main SQL tutorial. PR #1813 by @short2strings.
  • 🛠 Fix typo in tutorial about behind a proxy. PR #1807 by @toidi.
  • 🛠 Fix typo in Portuguese docs. PR #1795 by @izaguerreiro.
  • ➕ Add translations setup for Ukrainian. PR #1830.
  • ➕ Add external link Build And Host Fast Data Science Applications Using FastAPI. PR #1786 by @Kludex.
  • 🛠 Fix encoding of Pydantic models that inherit from others models with custom json_encoders. PR #1769 by @henrybetts.
  • Simplify and improve jsonable_encoder. PR #1754 by @MashhadiNima.
  • Simplify internal code syntax in several points. PR #1753 by @uriyyo.
  • 👌 Improve internal typing, declare Optional parameters. PR #1731 by @MashhadiNima.
  • ➕ Add external link Deploy FastAPI on Azure App Service to docs. PR #1726 by @windson.
  • ➕ Add link to Starlette docs about WebSocket testing. PR #1717 by @hellocoldworld.
  • 🔨 Refactor generating dependant, merge for loops. PR #1714 by @Bloodielie.
  • ⚡️ Update example for templates with Jinja to include HTML media type. PR #1690 by @frafra.
  • 🛠 Fix typos in docs for security. PR #1678 by @nilslindemann.
  • 🛠 Fix typos in docs for dependencies. PR #1675 by @nilslindemann.
  • 🛠 Fix type annotation for **extra parameters in FastAPI. PR #1659 by @bharel.
  • ⬆️ Bump MkDocs Material to fix docs in browsers with dark mode. PR #1789 by @adriencaccia.
  • ✂ Remove docs preview comment from each commit. PR #1826.
  • ⚡️ Update GitHub context extraction for Gitter notification bot. PR #1766.

• v0.60.1 Changes

  July 22, 2020

  • ➕ Add debugging logs for GitHub actions to introspect GitHub hidden context. PR #1764.
  • 📄 Use OS preference theme for online docs. PR #1760 by @adriencaccia.
  • ⬆️ Upgrade Starlette to version 0.13.6 to handle a vulnerability when using static files in Windows. PR #1759 by @jamesag26.
  • 📌 Pin Swagger UI temporarily, waiting for a fix for swagger-api/swagger-ui#6249. PR #1763.
  • ⚡️ Update GitHub Actions, use commit from PR for docs preview, not commit from pre-merge. PR #1761.
  • 🔨 Update GitHub Actions, refactor Gitter bot. PR #1746.

• v0.60.0 Changes

  July 20, 2020

  • ➕ Add GitHub Action to watch for missing preview docs and trigger a preview deploy. PR #1740.
  • ➕ Add custom GitHub Action to get artifact with docs preview. PR #1739.
  • ➕ Add new GitHub Actions to preview docs from PRs. PR #1738.
  • ➕ Add XML test coverage to support GitHub Actions. PR #1737.
  • ⚡️ Update badges and remove Travis now that GitHub Actions is the main CI. PR #1736.
  • ➕ Add GitHub Actions for CI, move from Travis. PR #1735.
  • ➕ Add support for adding OpenAPI schema for GET requests with a body. PR #1626 by @victorphoenix3.

• v0.59.0 Changes

  July 10, 2020

  • 🛠 Fix typo in docstring for OAuth2 utils. PR #1621 by @tomarv2.
  • ⚡️ Update JWT docs to use Python-jose instead of PyJWT. Initial PR #1610 by @asheux.
  • 🛠 Fix/re-enable search bar in docs. PR #1703.
  • Auto-generate a "server" in OpenAPI servers when there's a root_path instead of prefixing all the paths:
    • Add a new parameter for FastAPI classes: root_path_in_servers to disable the auto-generation of servers.
    • New docs about root_path and servers in Additional Servers.
    • Update OAuth2 examples to use a relative URL for tokenUrl="token" to make sure those examples keep working as-is even when behind a reverse proxy.
    • Initial PR #1596 by @rkbeatss.
  • 🛠 Fix typo/link in External Links. PR #1702.
  • ⚡️ Update handling of External Links to use a data file and allow translating the headers without becoming obsolete quickly when new links are added. PR #https://github.com/tiangolo/fastapi/pull/1701.
  • ➕ Add external link Machine learning model serving in Python using FastAPI and Streamlit to docs. PR #1669 by @davidefiocco.
  • ➕ Add note in docs on order in Pydantic Unions. PR #1591 by @kbanc.
  • 👌 Improve support for tests in editor. PR #1699.
  • 📌 Pin dependencies. PR #1697.
  • ⚡️ Update isort to version 5.x.x. PR #1670 by @asheux.

• v0.58.1 Changes

  June 28, 2020

  • ➕ Add link in docs to Pydantic data types. PR #1612 by @tayoogunbiyi.
  • 🛠 Fix link in warning logs for openapi_prefix. PR #1611 by @bavaria95.
  • 🛠 Fix bad link in docs. PR #1603 by @molto0504.
  • ➕ Add Vim temporary files to .gitignore for contributors using Vim. PR #1590 by @asheux.
  • 🛠 Fix typo in docs for sub-applications. PR #1578 by @schlpbch.
  • ⚡️ Use Optional in all the examples in the docs. Original PR #1574 by @chrisngyn, @kx-chen, @YKo20010. Updated and merged PR #1644.
  • Update tests and handling of response_model_by_alias. PR #1642.
  • ➕ Add translation to Chinese for Body - Fields - 请求体 - 字段. PR #1569 by @waynerv.
  • ⚡️ Update Chinese translation of main page. PR #1564 by @waynerv.
  • ➕ Add translation to Chinese for Body - Multiple Parameters - 请求体 - 多个参数. PR #1532 by @waynerv.
  • ➕ Add translation to Chinese for Path Parameters and Numeric Validations - 路径参数和数值校验. PR #1506 by @waynerv.
  • ➕ Add GitHub action to auto-label approved PRs (mainly for translations). PR #1638.

• v0.58.0 Changes

  June 15, 2020

  • 📇 Deep merge OpenAPI responses to preserve all the additional metadata. PR #1577.
  • 📄 Mention in docs that only main app events are run (not sub-apps). PR #1554 by @amacfie.
  • 🛠 Fix body validation error response, do not include body variable when it is not embedded. PR #1553 by @amacfie.
  • 🛠 Fix testing OAuth2 security scopes when using dependency overrides. PR #1549 by @amacfie.
  • 🛠 Fix Model for JSON Schema keyword not as a JSON Schema instead of a list. PR #1548 by @v-do.
  • ➕ Add support for OpenAPI servers. PR #1547 by @mikaello.

• 1
• 2
• Next ›
• Last »