Search Options

Results per page
Sort
Preferred Languages
Advance

Results 1 - 10 of 15 for describe (0.17 sec)

  1. docs/en/docs/how-to/separate-openapi-schemas.md

    That means that, clients using your API don't have to check if the value exists or not, they can **assume the field will always be there**, but just that in some cases it will have the default value of `None`.
    
    The way to describe this in OpenAPI, is to mark that field as **required**, because it will always be there.
    
    Because of that, the JSON Schema for a model can be different depending on if it's used for **input or output**:
    
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Tue Oct 17 05:59:11 GMT 2023
    - 6.7K bytes
    - Viewed (0)
  2. docs/en/docs/advanced/sub-applications.md

    ### Technical Details: `root_path`
    
    When you mount a sub-application as described above, FastAPI will take care of communicating the mount path for the sub-application using a mechanism from the ASGI specification called a `root_path`.
    
    That way, the sub-application will know to use that path prefix for the docs UI.
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 2.9K bytes
    - Viewed (0)
  3. docs/pt/docs/advanced/events.md

    ```
    
    ## Eventos alternativos (deprecados)
    
    !!! warning "Aviso"
        A maneira recomendada para lidar com a *inicialização* e o *encerramento* é usando o parâmetro `lifespan` da aplicação `FastAPI` como descrito acima.
    
        Você provavelmente pode pular essa parte.
    
    Existe uma forma alternativa para definir a execução dessa lógica durante *inicialização* e durante *encerramento*.
    
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 8.6K bytes
    - Viewed (0)
  4. docs/en/docs/advanced/response-cookies.md

    ## Return a `Response` directly
    
    You can also create cookies when returning a `Response` directly in your code.
    
    To do that, you can create a response as described in [Return a Response Directly](response-directly.md){.internal-link target=_blank}.
    
    Then set Cookies in it, and then return it:
    
    ```Python hl_lines="10-12"
    {!../../../docs_src/response_cookies/tutorial001.py!}
    ```
    
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Thu Jan 11 16:31:18 GMT 2024
    - 2.2K bytes
    - Viewed (0)
  5. docs/en/docs/advanced/events.md

    {!../../../docs_src/events/tutorial003.py!}
    ```
    
    ## Alternative Events (deprecated)
    
    !!! warning
        The recommended way to handle the *startup* and *shutdown* is using the `lifespan` parameter of the `FastAPI` app as described above. If you provide a `lifespan` parameter, `startup` and `shutdown` event handlers will no longer be called. It's all `lifespan` or all events, not both.
    
        You can probably skip this part.
    
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 7.8K bytes
    - Viewed (0)
  6. docs/es/docs/python-types.md

    Era `upper`? O era `uppercase`? `first_uppercase`? `capitalize`?
    
    Luego lo intentas con el viejo amigo de los programadores, el auto-completado del editor.
    
    Escribes el primer parámetro de la función `first_name`, luego un punto (`.`) y luego presionas `Ctrl+Space` para iniciar el auto-completado.
    
    Tristemente, no obtienes nada útil:
    
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Fri Mar 22 01:42:11 GMT 2024
    - 9.2K bytes
    - Viewed (0)
  7. docs/en/docs/tutorial/testing.md

    And your **FastAPI** application might also be composed of several files/modules, etc.
    
    ### **FastAPI** app file
    
    Let's say you have a file structure as described in [Bigger Applications](bigger-applications.md){.internal-link target=_blank}:
    
    ```
    .
    ├── app
    │   ├── __init__.py
    │   └── main.py
    ```
    
    In the file `main.py` you have your **FastAPI** app:
    
    
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Thu Apr 18 19:53:19 GMT 2024
    - 6.2K bytes
    - Viewed (0)
  8. docs/en/docs/how-to/graphql.md

    ## Learn More
    
    You can learn more about **GraphQL** in the <a href="https://graphql.org/" class="external-link" target="_blank">official GraphQL documentation</a>.
    
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Sat Aug 19 19:54:04 GMT 2023
    - 3.4K bytes
    - Viewed (0)
  9. docs/es/docs/advanced/response-directly.md

    ```
    
    ## Notas
    
    Cuando devuelves una `Response` directamente, los datos no son validados, convertidos (serializados), ni documentados automáticamente.
    
    Pero todavía es posible documentarlo como es descrito en [Respuestas adicionales en OpenAPI](additional-responses.md){.internal-link target=_blank}.
    
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Sat Jan 13 11:57:27 GMT 2024
    - 3.2K bytes
    - Viewed (0)
  10. docs/es/docs/advanced/response-headers.md

    
    ## Retornar una `Response` directamente
    
    Adicionalmente, puedes añadir headers cuando se retorne una `Response` directamente.
    
    Crea un response tal como se describe en [Retornar una respuesta directamente](response-directly.md){.internal-link target=_blank} y pasa los headers como un parámetro adicional:
    
    ```Python hl_lines="10-12"
    {!../../../docs_src/response_headers/tutorial001.py!}
    ```
    Plain Text
    - Registered: Sun Apr 28 07:19:10 GMT 2024
    - Last Modified: Wed Feb 07 12:51:12 GMT 2024
    - 2.5K bytes
    - Viewed (0)
Back to top