Search Options

Results per page
Sort
Preferred Languages
Advance

Results 1 - 10 of 120 for example (0.29 sec)

  1. docs/ru/docs/tutorial/schema-extra-example.md

    Итак, хотя поле `example` не является частью JSON-схемы, оно является частью настраиваемой версии JSON-схемы в OpenAPI, и именно это поле будет использоваться в UI документации.
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Fri Mar 22 01:42:11 GMT 2024
    - 11.6K bytes
    - Viewed (0)
  2. docs/ko/docs/tutorial/schema-extra-example.md

    !!! info "정보"
        (FastAPI 0.99.0부터 쓰이기 시작한) OpenAPI 3.1.0은 **JSON 스키마** 표준의 일부인 `examples`에 대한 지원을 추가했습니다.
    
        그 전에는, 하나의 예제만 가능한 `example` 키워드만 지원했습니다. 이는 아직 OpenAPI 3.1.0에서 지원하지만, 지원이 종료될 것이며 JSON 스키마 표준에 포함되지 않습니다. 그렇기에 `example`을 `examples`으로 이전하는 것을 추천합니다. 🤓
    
        이 문서 끝에 더 많은 읽을거리가 있습니다.
    
    ## `Field` 추가 인자
    
    Pydantic 모델과 같이 `Field()`를 사용할 때 추가적인 `examples`를 선언할 수 있습니다:
    
    === "Python 3.10+"
    
        ```Python hl_lines="2  8-11"
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Fri Feb 09 12:35:46 GMT 2024
    - 13.6K bytes
    - Viewed (0)
  3. docs/en/docs/tutorial/schema-extra-example.md

    ### Using the `openapi_examples` Parameter
    
    You can declare the OpenAPI-specific `examples` in FastAPI with the parameter `openapi_examples` for:
    
    * `Path()`
    * `Query()`
    * `Header()`
    * `Cookie()`
    * `Body()`
    * `Form()`
    * `File()`
    
    The keys of the `dict` identify each example, and each value is another `dict`.
    
    Each specific example `dict` in the `examples` can contain:
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 11.8K bytes
    - Viewed (0)
  4. docs/de/docs/tutorial/schema-extra-example.md

    === "Python 3.10+"
    
        ```Python hl_lines="2  8-11"
        {!> ../../../docs_src/schema_extra_example/tutorial002_py310.py!}
        ```
    
    === "Python 3.8+"
    
        ```Python hl_lines="4  10-13"
        {!> ../../../docs_src/schema_extra_example/tutorial002.py!}
        ```
    
    ## `examples` im JSON-Schema – OpenAPI
    
    Bei Verwendung von:
    
    Plain Text
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Sat Mar 30 20:19:53 GMT 2024
    - 13.3K bytes
    - Viewed (0)
  5. fastapi/params.py

            **extra: Any,
        ):
            if example is not _Unset:
                warnings.warn(
                    "`example` has been deprecated, please use `examples` instead",
                    category=DeprecationWarning,
                    stacklevel=4,
                )
            self.example = example
            self.include_in_schema = include_in_schema
            self.openapi_examples = openapi_examples
            kwargs = dict(
    Python
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Thu Apr 18 19:40:57 GMT 2024
    - 27.5K bytes
    - Viewed (1)
  6. tests/test_schema_extra_examples.py

                item: Item = Body(
                    example={"data": "Overridden example"},
                    examples=[
                        {"data": "examples example_examples 1"},
                        {"data": "examples example_examples 2"},
                    ],
                ),
            ):
                return item
    
        # TODO: enable these tests once/if Form(embed=False) is supported
    Python
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Tue Oct 24 20:26:06 GMT 2023
    - 37.7K bytes
    - Viewed (0)
  7. fastapi/security/http.py

        `HTTPDigest` in a dependency.
    
        The HTTP authorization header value is split by the first space.
    
        The first part is the `scheme`, the second part is the `credentials`.
    
        For example, in an HTTP Bearer token scheme, the client will send a header
        like:
    
        ```
        Authorization: Bearer deadbeef12346
        ```
    
        In this case:
    
        * `scheme` will have the value `"Bearer"`
    Python
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Fri Apr 19 15:29:38 GMT 2024
    - 13.2K bytes
    - Viewed (0)
  8. docs/en/docs/tutorial/response-model.md

    That's why in this example we have to declare it in the `response_model` parameter.
    
    ...but continue reading below to see how to overcome that.
    
    ## Return Type and Data Filtering
    
    Let's continue from the previous example. We wanted to **annotate the function with one type** but return something that includes **more data**.
    
    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)
  9. fastapi/security/oauth2.py

        Read more about it in the
        [FastAPI docs for Simple OAuth2 with Password and Bearer](https://fastapi.tiangolo.com/tutorial/security/simple-oauth2/).
    
        ## Example
    
        ```python
        from typing import Annotated
    
        from fastapi import Depends, FastAPI
        from fastapi.security import OAuth2PasswordRequestForm
    
        app = FastAPI()
    
    
        @app.post("/login")
    Python
    - Registered: Sun May 05 07:19:11 GMT 2024
    - Last Modified: Tue Apr 02 02:48:51 GMT 2024
    - 21.1K bytes
    - Viewed (1)
  10. docs/en/docs/advanced/behind-a-proxy.md

    ```JSON hl_lines="4-8"
    {
        "openapi": "3.1.0",
        // More stuff here
        "servers": [
            {
                "url": "/api/v1"
            }
        ],
        "paths": {
                // More stuff here
        }
    }
    ```
    
    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)
Back to top