3.3 KiB
General - Cómo Hacer - Recetas
Aquí tienes varias indicaciones hacia otros lugares en la documentación, para preguntas generales o frecuentes.
Filtrar Datos - Seguridad
Para asegurarte de que no devuelves más datos de los que deberías, lee la documentación para Tutorial - Modelo de Response - Tipo de Retorno.
Optimizar el Rendimiento del Response - Modelo de Response - Tipo de Retorno
Para optimizar el rendimiento al devolver datos JSON, usa un tipo de retorno o un modelo de Response; de esa manera Pydantic se encargará de la serialización a JSON del lado de Rust, sin pasar por Python. Lee más en la documentación para Tutorial - Modelo de Response - Tipo de Retorno.
Etiquetas de Documentación - OpenAPI
Para agregar etiquetas a tus path operations, y agruparlas en la interfaz de usuario de la documentación, lee la documentación para Tutorial - Configuraciones de Path Operation - Etiquetas.
Resumen y Descripción de Documentación - OpenAPI
Para agregar un resumen y descripción a tus path operations, y mostrarlos en la interfaz de usuario de la documentación, lee la documentación para Tutorial - Configuraciones de Path Operation - Resumen y Descripción.
Documentación de Descripción de Response - OpenAPI
Para definir la descripción del response, mostrada en la interfaz de usuario de la documentación, lee la documentación para Tutorial - Configuraciones de Path Operation - Descripción del Response.
Documentar la Deprecación de una Path Operation - OpenAPI
Para deprecar una path operation, y mostrarla en la interfaz de usuario de la documentación, lee la documentación para Tutorial - Configuraciones de Path Operation - Deprecación.
Convertir cualquier Dato a Compatible con JSON
Para convertir cualquier dato a compatible con JSON, lee la documentación para Tutorial - Codificador Compatible con JSON.
Metadatos OpenAPI - Documentación
Para agregar metadatos a tu esquema de OpenAPI, incluyendo una licencia, versión, contacto, etc, lee la documentación para Tutorial - Metadatos y URLs de Documentación.
URL Personalizada de OpenAPI
Para personalizar la URL de OpenAPI (o eliminarla), lee la documentación para Tutorial - Metadatos y URLs de Documentación.
URLs de Documentación de OpenAPI
Para actualizar las URLs usadas para las interfaces de usuario de documentación generadas automáticamente, lee la documentación para Tutorial - Metadatos y URLs de Documentación.