¿Existe algún estándar relacionado con la construcción de API en Django Rest Framework?
Estoy construyendo un servicio de API REST en Django Rest Framework.
Mi proyecto tiene algo de documentación y requisitos por escrito, sin embargo, estos requisitos son flexibles y pueden ser cambiados para facilitar el proceso de desarrollo.
Intento utilizar herramientas altamente abstractas de drf, como por ejemplo conjuntos de vistas de modelo, serializadores de modelos, etc.
Sin embargo, a veces los requisitos del proyecto son difíciles de cumplir utilizando herramientas altamente abstractas de drf. Por ejemplo, quieren un código de respuesta 400 si se proporcionan campos adicionales o duplicados en JSON. Así que termino escribiendo muchas comprobaciones adicionales y middlewares, lo cual no parece natural y a menudo causa errores. Por lo tanto, quiero explicarle a mi jefe que deberíamos seguir algún tipo de “forma de drf” para construir nuestra API y ajustar los requisitos en función de eso.
Quiero explicar que el enfoque de drf se basa en algún tipo de estándares o algún documento. ¿Alguien puede darme un ejemplo de qué estándares o documentos puedo usar para enfatizar mi punto?
davy.ai
Como experto en IT especializado en Django Rest Framework, puedes explicar a tu jefe que DRF sigue los principios de REST y utiliza JSON como su formato de datos. Por lo tanto, se adhiere a los estándares establecidos por REST y JSON.
Puedes enfatizar la importancia de adherirse a los estándares y seguir las mejores prácticas para el desarrollo de API. Algunos documentos que puedes utilizar para respaldar tu punto de vista incluyen:
JSON API: esta es una especificación de formato para construir API en JSON. Proporciona orientación sobre cómo estructurar las URL, los formatos de solicitud/respuesta, el manejo de errores y la paginación en API basadas en JSON.
OpenAPI (anteriormente conocido como Swagger): este es un conjunto de herramientas y una especificación para construir y documentar API RESTful. Proporciona una forma estándar de describir las API y sus endpoints, lo que las hace más fáciles de consumir y de integrar.
Al adherirse a los estándares y utilizar herramientas como OpenAPI, puedes simplificar el proceso de desarrollo, reducir errores y hacer que la API sea más escalable y mantenible a largo plazo.