Search Options

Results per page
Sort
Preferred Languages
Advance

Results 1 - 10 of 112 for where (0.35 sec)

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

    * It will **limit and filter** the output data to what is defined in the return type.
        * This is particularly important for **security**, we'll see more of that below.
    
    ## `response_model` Parameter
    
    There are some cases where you need or want to return some data that is not exactly what the type declares.
    
    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. docs/en/docs/how-to/conditional-openapi.md

    * Implement and use well-known cryptographic tools, like Passlib and JWT tokens, etc.
    * Add more granular permission controls with OAuth2 scopes where needed.
    * ...etc.
    
    Nevertheless, you might have a very specific use case where you really need to disable the API docs for some environment (e.g. for production) or depending on configurations from environment variables.
    
    ## Conditional OpenAPI from settings and env vars
    
    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)
  3. docs/en/docs/tutorial/path-params.md

    Because of this, **FastAPI** itself provides an alternative API documentation (using ReDoc), which you can access at <a href="http://127.0.0.1:8000/redoc" class="external-link" target="_blank">http://127.0.0.1:8000/redoc</a>:
    
    <img src="/img/tutorial/path-params/image02.png">
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Fri Mar 22 01:42:11 GMT 2024
    - 9.1K bytes
    - Viewed (0)
  4. docs/en/docs/tutorial/first-steps.md

    <font color="#4E9A06">INFO</font>:     Application startup complete.
    ```
    
    </div>
    
    In the output, there's a line with something like:
    
    ```hl_lines="4"
    INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
    ```
    
    That line shows the URL where your app is being served, in your local machine.
    
    ### Check it
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu May 02 22:37:31 GMT 2024
    - 12K bytes
    - Viewed (0)
  5. docs/en/docs/deployment/concepts.md

    Of course, there are some cases where there's no problem in running the previous steps multiple times, in that case, it's a lot easier to handle.
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu May 02 22:37:31 GMT 2024
    - 18K bytes
    - Viewed (0)
  6. docs/en/docs/advanced/generate-clients.md

    error out if you have any **mismatch** in the data used.
    
    So, you would **detect many errors** very early in the development cycle instead of having to wait for the errors to show up to your final users in production and then trying to debug where the problem is. ✨...
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 10.5K bytes
    - Viewed (0)
  7. docs/en/docs/deployment/manually.md

    When referring to the remote machine, it's common to call it **server**, but also **machine**, **VM** (virtual machine), **node**. Those all refer to some type of remote machine, normally running Linux, where you run programs.
    
    ## Install the Server Program
    
    When you install FastAPI, it comes with a production server, Uvicorn, and you can start it with the `fastapi run` command.
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu May 02 22:37:31 GMT 2024
    - 9.2K bytes
    - Viewed (0)
  8. docs/en/docs/contributing.md

    ### Virtual environment with `venv`
    
    You can create an isolated virtual local environment in a directory using Python's `venv` module. Let's do this in the cloned repository (where the `requirements.txt` is):
    
    <div class="termy">
    
    ```console
    $ python -m venv env
    ```
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Jan 11 17:42:43 GMT 2024
    - 14.1K bytes
    - Viewed (0)
  9. docs/en/docs/advanced/openapi-webhooks.md

    # OpenAPI Webhooks
    
    There are cases where you want to tell your API **users** that your app could call *their* app (sending a request) with some data, normally to **notify** of some type of **event**.
    
    This means that instead of the normal process of your users sending requests to your API, it's **your API** (or your app) that could **send requests to their system** (to their API, their app).
    
    This is normally called a **webhook**.
    
    ## Webhooks steps
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu May 02 22:37:31 GMT 2024
    - 2.8K bytes
    - Viewed (0)
  10. docs/en/docs/tutorial/security/oauth2-jwt.md

        ```
    
    ### Technical details about the JWT "subject" `sub`
    
    The JWT specification says that there's a key `sub`, with the subject of the token.
    
    It's optional to use it, but that's where you would put the user's identification, so we are using it here.
    
    JWT might be used for other things apart from identifying a user and allowing them to perform operations directly on your API.
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 13K bytes
    - Viewed (0)
Back to top