Search Options

Results per page
Sort
Preferred Languages
Advance

Results 1 - 10 of 15 for livable (0.16 sec)

  1. docs/en/docs/tutorial/response-model.md

    ### Disable Response Model
    
    Continuing from the example above, you might not want to have the default data validation, documentation, filtering, etc. that is performed by FastAPI.
    
    But you might want to still keep the return type annotation in the function to get the support from tools like editors and type checkers (e.g. mypy).
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 17.9K bytes
    - Viewed (0)
  2. fastapi/utils.py

                f"check that {type_} is a valid Pydantic field type. "
                "If you are using a return type annotation that is not a valid Pydantic "
                "field (e.g. Union[Response, dict, None]) you can disable generating the "
                "response model from the type annotation with the path operation decorator "
                "parameter response_model=None. Read more: "
                "https://fastapi.tiangolo.com/tutorial/response-model/"
    Python
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:40:57 GMT 2024
    - 7.8K bytes
    - Viewed (0)
  3. docs/en/docs/advanced/behind-a-proxy.md

    <img src="/img/tutorial/behind-a-proxy/image03.png">
    
    !!! tip
        The docs UI will interact with the server that you select.
    
    ### Disable automatic server from `root_path`
    
    If you don't want **FastAPI** to include an automatic server using the `root_path`, you can use the parameter `root_path_in_servers=False`:
    
    ```Python hl_lines="9"
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu May 02 22:37:31 GMT 2024
    - 11.6K bytes
    - Viewed (2)
  4. fastapi/param_functions.py

                if the dependency is needed by several dependencies), the value will be
                re-used for the rest of the request.
    
                Set `use_cache` to `False` to disable this behavior and ensure the
                dependency is called again (if declared more than once) in the same request.
                """
            ),
        ] = True,
    ) -> Any:
        """
    Python
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:40:57 GMT 2024
    - 62.5K bytes
    - Viewed (0)
  5. docs/en/docs/how-to/conditional-openapi.md

    # Conditional OpenAPI
    
    If you needed to, you could use settings and environment variables to configure OpenAPI conditionally depending on the environment, and even disable it entirely.
    
    ## About security, APIs, and docs
    
    Hiding your documentation user interfaces in production *shouldn't* be the way to protect your API.
    
    That doesn't add any extra security to your API, the *path operations* will still be available where they are.
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Sat Aug 19 19:54:04 GMT 2023
    - 2.3K bytes
    - Viewed (0)
  6. docs/en/docs/tutorial/metadata.md

    ```
    
    If you want to disable the OpenAPI schema completely you can set `openapi_url=None`, that will also disable the documentation user interfaces that use it.
    
    ## Docs URLs
    
    You can configure the two documentation user interfaces included:
    
    * **Swagger UI**: served at `/docs`.
        * You can set its URL with the parameter `docs_url`.
        * You can disable it by setting `docs_url=None`.
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Sun Mar 31 23:52:53 GMT 2024
    - 5.8K bytes
    - Viewed (0)
  7. docs/en/docs/release-notes.md

    * ➕ Replace mkdocs-markdownextradata-plugin with mkdocs-macros-plugin. PR [#11383](https://github.com/tiangolo/fastapi/pull/11383) by [@tiangolo](https://github.com/tiangolo).
    * 👷 Disable MkDocs insiders social plugin while an issue in MkDocs Material is handled. PR [#11373](https://github.com/tiangolo/fastapi/pull/11373) by [@tiangolo](https://github.com/tiangolo).
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Fri May 03 23:25:42 GMT 2024
    - 388.1K bytes
    - Viewed (1)
  8. docs/en/layouts/custom.yml

    # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    # FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
    # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
    # IN THE SOFTWARE.
    
    Others
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Mon Jun 26 14:05:43 GMT 2023
    - 6.5K bytes
    - Viewed (0)
  9. fastapi/applications.py

                bool,
                Doc(
                    """
                    To disable automatically generating the URLs in the `servers` field
                    in the autogenerated OpenAPI using the `root_path`.
    
                    Read more about it in the
                    [FastAPI docs for Behind a Proxy](https://fastapi.tiangolo.com/advanced/behind-a-proxy/#disable-automatic-server-from-root_path).
    
                    **Example**
    
    Python
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Tue Apr 02 02:48:51 GMT 2024
    - 172.2K bytes
    - Viewed (0)
  10. docs/en/docs/how-to/configure-swagger-ui.md

    ## Disable Syntax Highlighting
    
    For example, you could disable syntax highlighting in Swagger UI.
    
    Without changing the settings, syntax highlighting is enabled by default:
    
    <img src="/img/tutorial/extending-openapi/image02.png">
    
    But you can disable it by setting `syntaxHighlight` to `False`:
    
    ```Python hl_lines="3"
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 2.8K bytes
    - Viewed (0)
Back to top