Search Options

Results per page
Sort
Preferred Languages
Advance

Results 1 - 10 of 74 for disable (0.16 sec)

  1. 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)
  2. 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)
  3. 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)
  4. 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)
  5. 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)
  6. fastapi/param_functions.py

                """
            ),
        ] = None,
        include_in_schema: Annotated[
            bool,
            Doc(
                """
                To include (or not) this parameter field in the generated OpenAPI.
                You probably don't need it, but it's available.
    
                This affects the generated OpenAPI (e.g. visible at `/docs`).
                """
            ),
    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)
  7. docs_src/security/tutorial003_an_py39.py

            "email": "******@****.***",
            "hashed_password": "fakehashedsecret",
            "disabled": False,
        },
        "alice": {
            "username": "alice",
            "full_name": "Alice Wonderson",
            "email": "******@****.***",
            "hashed_password": "fakehashedsecret2",
            "disabled": True,
        },
    }
    
    app = FastAPI()
    
    
    def fake_hash_password(password: str):
    Python
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Tue Mar 26 16:56:53 GMT 2024
    - 2.5K bytes
    - Viewed (0)
  8. docs_src/security/tutorial004.py

            "disabled": False,
        }
    }
    
    
    class Token(BaseModel):
        access_token: str
        token_type: str
    
    
    class TokenData(BaseModel):
        username: Union[str, None] = None
    
    
    class User(BaseModel):
        username: str
        email: Union[str, None] = None
        full_name: Union[str, None] = None
        disabled: Union[bool, None] = None
    
    
    class UserInDB(User):
    Python
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Tue Mar 26 16:56:53 GMT 2024
    - 4K bytes
    - Viewed (0)
  9. docs_src/security/tutorial004_an.py

            "disabled": False,
        }
    }
    
    
    class Token(BaseModel):
        access_token: str
        token_type: str
    
    
    class TokenData(BaseModel):
        username: Union[str, None] = None
    
    
    class User(BaseModel):
        username: str
        email: Union[str, None] = None
        full_name: Union[str, None] = None
        disabled: Union[bool, None] = None
    
    
    class UserInDB(User):
    Python
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Tue Mar 26 16:56:53 GMT 2024
    - 4.1K bytes
    - Viewed (0)
  10. tests/test_tutorial/test_security/test_tutorial005_an.py

                                {"title": "Full Name", "type": "string"}
                            ),
                            "disabled": IsDict(
                                {
                                    "title": "Disabled",
                                    "anyOf": [{"type": "boolean"}, {"type": "null"}],
                                }
                            )
                            | IsDict(
    Python
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Wed Mar 13 19:07:10 GMT 2024
    - 15.4K bytes
    - Viewed (0)
Back to top