Browse Source
Co-authored-by: Camila Gutierrez <[email protected]> Co-authored-by: Sebastián Ramírez <[email protected]> Co-authored-by: Camila Gutierrez <[email protected]>pull/3458/head
committed by
GitHub
1 changed files with 52 additions and 0 deletions
@ -0,0 +1,52 @@ |
|||||
|
# Configuración avanzada de las operaciones de path |
||||
|
|
||||
|
## OpenAPI operationId |
||||
|
|
||||
|
!!! warning "Advertencia" |
||||
|
Si no eres una persona "experta" en OpenAPI, probablemente no necesitas leer esto. |
||||
|
|
||||
|
Puedes asignar el `operationId` de OpenAPI para ser usado en tu *operación de path* con el parámetro `operation_id`. |
||||
|
|
||||
|
En este caso tendrías que asegurarte de que sea único para cada operación. |
||||
|
|
||||
|
```Python hl_lines="6" |
||||
|
{!../../../docs_src/path_operation_advanced_configuration/tutorial001.py!} |
||||
|
``` |
||||
|
|
||||
|
### Usando el nombre de la *función de la operación de path* en el operationId |
||||
|
|
||||
|
Si quieres usar tus nombres de funciones de API como `operationId`s, puedes iterar sobre todos ellos y sobrescribir `operation_id` de cada *operación de path* usando su `APIRoute.name`. |
||||
|
|
||||
|
Deberías hacerlo después de adicionar todas tus *operaciones de path*. |
||||
|
|
||||
|
```Python hl_lines="2 12 13 14 15 16 17 18 19 20 21 24" |
||||
|
{!../../../docs_src/path_operation_advanced_configuration/tutorial002.py!} |
||||
|
``` |
||||
|
|
||||
|
!!! tip "Consejo" |
||||
|
Si llamas manualmente a `app.openapi()`, debes actualizar el `operationId`s antes de hacerlo. |
||||
|
|
||||
|
!!! warning "Advertencia" |
||||
|
Si haces esto, debes asegurarte de que cada una de tus *funciones de las operaciones de path* tenga un nombre único. |
||||
|
|
||||
|
Incluso si están en diferentes módulos (archivos Python). |
||||
|
|
||||
|
## Excluir de OpenAPI |
||||
|
|
||||
|
Para excluir una *operación de path* del esquema OpenAPI generado (y por tanto del la documentación generada automáticamente), usa el parámetro `include_in_schema` y asigna el valor como `False`; |
||||
|
|
||||
|
```Python hl_lines="6" |
||||
|
{!../../../docs_src/path_operation_advanced_configuration/tutorial003.py!} |
||||
|
``` |
||||
|
|
||||
|
## Descripción avanzada desde el docstring |
||||
|
|
||||
|
Puedes limitar las líneas usadas desde el docstring de una *operación de path* para OpenAPI. |
||||
|
|
||||
|
Agregar un `\f` (un carácter de "form feed" escapado) hace que **FastAPI** trunque el output utilizada para OpenAPI en ese punto. |
||||
|
|
||||
|
No será mostrado en la documentación, pero otras herramientas (como Sphinx) serán capaces de usar el resto. |
||||
|
|
||||
|
```Python hl_lines="19 20 21 22 23 24 25 26 27 28 29" |
||||
|
{!../../../docs_src/path_operation_advanced_configuration/tutorial004.py!} |
||||
|
``` |
Loading…
Reference in new issue