Search Options

Results per page
Sort
Preferred Languages
Advance

Results 1 - 10 of 12 for NOTE (0.24 sec)

  1. docs/en/docs/tutorial/first-steps.md

    ### Step 1: import `FastAPI`
    
    ```Python hl_lines="1"
    {!../../../docs_src/first_steps/tutorial001.py!}
    ```
    
    `FastAPI` is a Python class that provides all the functionality for your API.
    
    !!! note "Technical Details"
        `FastAPI` is a class that inherits directly from `Starlette`.
    
    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)
  2. docs/en/docs/deployment/manually.md

    === "Hypercorn"
    
        <div class="termy">
    
        ```console
        $ hypercorn main:app --bind 0.0.0.0:80
    
        Running on 0.0.0.0:8080 over http (CTRL + C to quit)
        ```
    
        </div>
    
    !!! note
        The command `uvicorn main:app` refers to:
    
        * `main`: the file `main.py` (the Python "module").
        * `app`: the object created inside of `main.py` with the line `app = FastAPI()`.
    
        It is equivalent to:
    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)
  3. docs/en/docs/advanced/behind-a-proxy.md

    <span style="color: green;">INFO</span>:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
    ```
    
    </div>
    
    If you use Hypercorn, it also has the option `--root-path`.
    
    !!! note "Technical Details"
        The ASGI specification defines a `root_path` for this use case.
    
        And the `--root-path` command line option provides that `root_path`.
    
    ### Checking the current `root_path`
    
    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. docs/zh/docs/index.md

    @app.get("/")
    async def read_root():
        return {"Hello": "World"}
    
    
    @app.get("/items/{item_id}")
    async def read_item(item_id: int, q: Union[str, None] = None):
        return {"item_id": item_id, "q": q}
    ```
    
    **Note**:
    
    如果你不知道是否会用到,可以查看文档的 _"In a hurry?"_ 章节中 <a href="https://fastapi.tiangolo.com/zh/async/#in-a-hurry" target="_blank">关于 `async` 和 `await` 的部分</a>。
    
    </details>
    
    ### 运行
    
    通过以下命令运行服务器:
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Mon Apr 29 05:18:04 GMT 2024
    - 18.2K bytes
    - Viewed (0)
  5. docs/en/docs/release-notes.md

    participant dep as Dep with yield
    participant operation as Path Operation
    participant tasks as Background tasks
    
        Note over client,tasks: Can raise exception for dependency, handled after response is sent
        Note over client,operation: Can raise HTTPException and can change the response
        client ->> dep: Start request
        Note over dep: Run code up to yield
        opt raise
            dep -->> handler: Raise HTTPException
    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)
  6. docs/en/docs/advanced/websockets.md

    ```
    
    ## Create a `websocket`
    
    In your **FastAPI** application, create a `websocket`:
    
    ```Python hl_lines="1  46-47"
    {!../../../docs_src/websockets/tutorial001.py!}
    ```
    
    !!! note "Technical Details"
        You could also use `from starlette.websockets import WebSocket`.
    
        **FastAPI** provides the same `WebSocket` directly just as a convenience for you, the developer. But it comes directly from Starlette.
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu May 02 22:37:31 GMT 2024
    - 6.2K bytes
    - Viewed (0)
  7. docs/en/docs/tutorial/index.md

    ---
    
    ## Install FastAPI
    
    The first step is to install FastAPI:
    
    <div class="termy">
    
    ```console
    $ pip install fastapi
    
    ---> 100%
    ```
    
    </div>
    
    !!! note
        When you install with `pip install fastapi` it comes with some default optional standard dependencies.
    
        If you don't want to have those optional dependencies, you can instead install `pip install fastapi-slim`.
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu May 02 22:37:31 GMT 2024
    - 5.9K bytes
    - Viewed (0)
  8. docs/fr/docs/index.md

    @app.get("/")
    async def read_root():
        return {"Hello": "World"}
    
    
    @app.get("/items/{item_id}")
    async def read_item(item_id: int, q: Union[str, None] = None):
        return {"item_id": item_id, "q": q}
    ```
    
    **Note**
    
    Si vous n'êtes pas familier avec cette notion, consultez la section _"Vous êtes pressés ?"_ à propos de <a href="https://fastapi.tiangolo.com/fr/async/#vous-etes-presses" target="_blank">`async` et `await` dans la documentation</a>.
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Mon Apr 29 05:18:04 GMT 2024
    - 22K bytes
    - Viewed (0)
  9. README.md

    @app.get("/")
    async def read_root():
        return {"Hello": "World"}
    
    
    @app.get("/items/{item_id}")
    async def read_item(item_id: int, q: Union[str, None] = None):
        return {"item_id": item_id, "q": q}
    ```
    
    **Note**:
    
    If you don't know, check the _"In a hurry?"_ section about <a href="https://fastapi.tiangolo.com/async/#in-a-hurry" target="_blank">`async` and `await` in the docs</a>.
    
    </details>
    
    ### Run it
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu May 02 22:37:31 GMT 2024
    - 22.6K bytes
    - Viewed (0)
  10. docs/en/docs/index.md

    @app.get("/")
    async def read_root():
        return {"Hello": "World"}
    
    
    @app.get("/items/{item_id}")
    async def read_item(item_id: int, q: Union[str, None] = None):
        return {"item_id": item_id, "q": q}
    ```
    
    **Note**:
    
    If you don't know, check the _"In a hurry?"_ section about <a href="https://fastapi.tiangolo.com/async/#in-a-hurry" target="_blank">`async` and `await` in the docs</a>.
    
    </details>
    
    ### Run it
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu May 02 22:37:31 GMT 2024
    - 19.8K bytes
    - Viewed (0)
Back to top