Search Options

Results per page
Sort
Preferred Languages
Advance

Results 1 - 10 of 122 for operations (0.15 sec)

  1. docs/en/docs/advanced/generate-clients.md

    ```
    
    ...that's because the client generator uses the OpenAPI internal **operation ID** for each *path operation*.
    
    OpenAPI requires that each operation ID is unique across all the *path operations*, so FastAPI uses the **function name**, the **path**, and the **HTTP method/operation** to generate that operation ID, because that way it can make sure that the operation IDs are unique.
    
    But I'll show you how to improve that next. 🤓
    
    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)
  2. docs/en/docs/tutorial/bigger-applications.md

    And we can add a list of `dependencies` that will be added to all the *path operations* in the router and will be executed/solved for each request made to them.
    
    !!! tip
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 18.6K bytes
    - Viewed (0)
  3. docs/en/docs/advanced/sub-applications.md

    ### Top-level application
    
    First, create the main, top-level, **FastAPI** application, and its *path operations*:
    
    ```Python hl_lines="3  6-8"
    {!../../../docs_src/sub_applications/tutorial001.py!}
    ```
    
    ### Sub-application
    
    Then, create your sub-application, and its *path operations*.
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 2.9K bytes
    - Viewed (0)
  4. docs/en/docs/tutorial/testing.md

    │   ├── main.py
    │   └── test_main.py
    ```
    
    Let's say that now the file `main.py` with your **FastAPI** app has some other **path operations**.
    
    It has a `GET` operation that could return an error.
    
    It has a `POST` operation that could return several errors.
    
    Both *path operations* require an `X-Token` header.
    
    === "Python 3.10+"
    
        ```Python
        {!> ../../../docs_src/app_testing/app_b_an_py310/main.py!}
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 6.2K bytes
    - Viewed (0)
  5. docs/en/docs/tutorial/first-steps.md

        It is the "**path operation decorator**".
    
    You can also use the other operations:
    
    * `@app.post()`
    * `@app.put()`
    * `@app.delete()`
    
    And the more exotic ones:
    
    * `@app.options()`
    * `@app.head()`
    * `@app.patch()`
    * `@app.trace()`
    
    !!! tip
        You are free to use each operation (HTTP method) as you wish.
    
    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)
  6. docs/en/docs/tutorial/path-params.md

    ## Order matters
    
    When creating *path operations*, you can find situations where you have a fixed path.
    
    Like `/users/me`, let's say that it's to get data about the current user.
    
    And then you can also have a path `/users/{user_id}` to get data about a specific user by some user ID.
    
    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)
  7. docs/en/docs/tutorial/metadata.md

    ### Use your tags
    
    Use the `tags` parameter with your *path operations* (and `APIRouter`s) to assign them to different tags:
    
    ```Python hl_lines="21  26"
    {!../../../docs_src/metadata/tutorial004.py!}
    ```
    
    !!! info
        Read more about tags in [Path Operation Configuration](path-operation-configuration.md#tags){.internal-link target=_blank}.
    
    ### Check the docs
    
    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)
  8. docs/en/docs/how-to/custom-request-and-route.md

    Doing this, our `GzipRequest` will take care of decompressing the data (if necessary) before passing it to our *path operations*.
    
    After that, all of the processing logic is the same.
    
    But because of our changes in `GzipRequest.body`, the request body will be automatically decompressed when it is loaded by **FastAPI** when needed.
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Sun Mar 31 23:52:53 GMT 2024
    - 4.4K bytes
    - Viewed (0)
  9. docs/ja/docs/tutorial/path-operation-configuration.md

    # Path Operationの設定
    
    *path operationデコレータ*を設定するためのパラメータがいくつかあります。
    
    !!! warning "注意"
        これらのパラメータは*path operation関数*ではなく、*path operationデコレータ*に直接渡されることに注意してください。
    
    ## レスポンスステータスコード
    
    *path operation*のレスポンスで使用する(HTTP)`status_code`を定義することができます。
    
    `404`のように`int`のコードを直接渡すことができます。
    
    しかし、それぞれの番号コードが何のためのものか覚えていない場合は、`status`のショートカット定数を使用することができます:
    
    ```Python hl_lines="3  17"
    {!../../../docs_src/path_operation_configuration/tutorial001.py!}
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Tue Apr 02 04:38:26 GMT 2024
    - 4.3K bytes
    - Viewed (0)
  10. docs/en/docs/advanced/openapi-webhooks.md

    ## Documenting webhooks with **FastAPI** and OpenAPI
    
    With **FastAPI**, using OpenAPI, you can define the names of these webhooks, the types of HTTP operations that your app can send (e.g. `POST`, `PUT`, etc.) and the request **bodies** that your app would send.
    
    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)
Back to top