¿Cuál es la forma correcta de crear una API sin un modelo detrás de ella?
Supongamos que quiero crear una API que no es compatible con un modelo. Se ingresan ciertos campos con la solicitud, se aplica un procesamiento y luego se devuelven otros campos.
La forma en que suelo hacerlo es definir una vista simple que instancie un serializador para realizar la validación. Y luego devuelvo los campos directamente desde la vista, por ejemplo, con un JSONResponse.
¿Es esta la forma correcta de hacerlo? ¿Tiene sentido utilizar un serializador para la validación? ¿Es mejor utilizar un formulario? ¿Debería serializarse la respuesta? ¿Es correcto procesar los datos de entrada en la vista?
davy.ai
Como experto en TI especializado en Django, Django-views y Django-serializer, aquí están mis sugerencias para hacer una API que no sea compatible con un modelo:
Utilice un serializador para la validación de datos: Aunque un serializador se utiliza principalmente para serializar y deserializar objetos Django, también es útil para validar los datos ingresados en una solicitud de API. Proporciona una forma estructurada de definir los campos de entrada esperados y sus tipos de datos, y también ayuda a manejar errores y excepciones que puedan ocurrir debido a entradas de datos no válidas.
Defina una vista para procesar los datos: Después de que los datos sean validados utilizando el serializador, es necesario procesarlos para generar los campos de salida requeridos. Esto se puede hacer en una vista dedicada que toma los datos validados como entrada y aplica la lógica de procesamiento necesaria para generar la salida.
Devuelva los campos de salida directamente desde la vista: Una vez que el procesamiento esté completo, la vista puede devolver directamente los campos de salida como una respuesta JSON sin necesidad de un modelo. Esto se debe a que la solicitud de API no necesita almacenar los datos procesados como parte de ningún modelo de base de datos.
Serialice los datos de respuesta: Es importante serializar los datos antes de devolverlos como una respuesta a la solicitud de API. Esto facilita que la aplicación del lado del cliente analice y utilice los datos de respuesta de manera estructurada.
Considere utilizar un formulario para la validación de datos: Si bien un serializador es una buena opción para la validación de datos en la mayoría de los casos, en algunos escenarios donde existe una lógica empresarial compleja, puede ser mejor utilizar un formulario para la validación. Los formularios permiten una mayor flexibilidad en el manejo de las entradas de datos y también se pueden personalizar para manejar requisitos de validación complejos.
Está bien procesar los datos de entrada en la vista: Dado que los datos no necesitan ser almacenados en un modelo de base de datos, es perfectamente aceptable procesarlos directamente en la vista. Sin embargo, si la lógica de procesamiento es compleja o si hay múltiples vistas que requieren la misma lógica de procesamiento, puede ser mejor abstraer la lógica de procesamiento en una función o clase de utilidad independiente para una mejor mantenibilidad.