Introducción china al marco de descanso de Django
El marco Django REST es un conjunto de herramientas potente y flexible para crear API web.
¿Por qué utilizar el marco REST?
Rest framework es un proyecto financiado de forma cooperativa (proyecto de fondos). Si utiliza rest framework con fines comerciales, le recomendamos encarecidamente que invierta en su desarrollo sostenible registrándose en un plan pago.
Cada registro nos ayuda a hacer que REST Framework sea financieramente sostenible a largo plazo.
Muchas gracias a todos nuestros maravillosos patrocinadores, así como a nuestros patrocinadores premium, Rovers, Sentinels, Streams, Mechanics y Scrolls.
Muchas gracias a todos nuestros maravillosos patrocinadores, especialmente a nuestros maravillosos seguidores, Rover, Sentry, Stream, Machinalis y Rollbar.
)
El marco REST tiene los siguientes requisitos:
Python (2.7, 3.2, 3.3, 3.4, 3.5, 3.6)
Django (1.7+, 1.8, 1.9, 2.0)
Los siguientes son los paquetes opcionales:
Instálelo usando pip, incluidos los paquetes opcionales que desee...
...o clonar el proyecto desde GitHub. (O copie el proyecto desde github)
Agregue "rest_framework" a la configuración INSTALLED_APPS.
Si planea utilizar la API navegable, es posible que también desee agregar las vistas de inicio y cierre de sesión del marco REST. Agregue el siguiente contenido a su archivo root_rls.py. (Si planea utilizar una API navegable, es posible que también desee agregar las vistas de inicio y cierre de sesión del marco REST. Agregue lo siguiente a su archivo raíz urls.py).
Tenga en cuenta que la ruta URL puede Sea el camino que desee. (Tenga en cuenta que la ruta URL puede ser la que desee).
Veamos un ejemplo sencillo de creación de una API respaldada por un modelo sencillo utilizando el marco REST. Veamos un ejemplo rápido del uso del marco REST para crear un modelo simple que admita una API.
Crearemos una API de lectura y escritura para acceder a la información del usuario del proyecto. )
Cualquier configuración global para la API de REST Framework se guarda en un diccionario de configuración llamado REST_FRAMEWORK. Primero agregue el siguiente contenido a Yoursettings.pymodule: (Cualquier configuración global para la API del marco de descanso se guarda en un diccionario de configuración llamado "rest_wramework". Primero, agregue el siguiente contenido al módulo "Entorno":)
No olvides asegurarte de haber agregado rest_framework a INSTALLED_APPS. (No olvide asegurarse de haber agregado "rest_framework" en "installed_apps").
Ahora estamos listos para crear nuestra API. Esta es la raíz de nuestro proyecto. Esta es la raíz del módulo urls.py de nuestro proyecto :)
Ahora puedes abrir la API en tu navegador y ver de manera predictiva cómo encaja todo, lo cual es una lectura muy recomendable. (Este tutorial lo ayudará a completar los componentes básicos que componen el marco REST. Le llevará un poco de tiempo completarlo, pero le brindará una comprensión profunda de cómo se integra todo y es una lectura muy recomendable).
Aquí hay un tutorial completo para fines de prueba API de instancia de API. Hay una API de creación de instancias, una API tutorial para fines de prueba, disponible aquí.
La Guía API es un manual de referencia completo para todas las funciones proporcionadas por el marco REST.
Pautas generales para el uso del framework REST. )
Consulte la Guía de contribución para obtener información sobre cómo clonar el repositorio, ejecutar el conjunto de pruebas y confirmar los cambios en el marco REST. (Para obtener información sobre cómo clonar el repositorio, ejecutar el conjunto de pruebas y contribuir con cambios al marco REST, consulte la Guía de contribución.
)
Para obtener ayuda, consulte el grupo de discusión de REST Framework, pruebe el canal #restframework en irc.freenode.net, busque en los archivos de IRC o haga una pregunta en Stack Overflow, asegurándose de incluir "django -REST- etiqueta del marco. (Para obtener ayuda, consulte el grupo de discusión de REST Framework. Pruebe el canal #restframework en IRC .freenode.net, busque el archivo IRC o haga una pregunta en Stack Overflow, asegurándose de incluir "django-rest-framework" tag.)
Para recibir soporte prioritario, regístrese en los planes Professional o Premium Accountability. (Para recibir soporte prioritario, regístrese en los programas de patrocinio Profesional o Premium).
Para obtener actualizaciones sobre el desarrollo del marco REST, es posible que también desee seguir al autor en Twitter. (Para obtener actualizaciones sobre el desarrollo del marco REST, es posible que también quieras seguir al autor en Twitter).
Sigue a @Tom Christie
Si crees que has descubierto algo seguro en Django REST Errores del marco, no plantee este problema en un foro público.
Envíe una descripción del problema por correo electrónico a rest-framework-security@googlegroups.com. Los mantenedores del proyecto trabajarán con usted para resolver cualquier problema que deba resolverse antes de cualquier divulgación pública.
Copyright (c) 2011-2017, Tom Christie. Todos los derechos reservados.
La redistribución y el uso en código fuente y en formato binario (con o sin modificación) están permitidos siempre que se cumplan las siguientes condiciones:
Las redistribuciones del código fuente deben conservar el aviso de derechos de autor anterior. y esta condición Listado y exención de responsabilidad a continuación. Las redistribuciones en formato binario deben reproducir el aviso de derechos de autor anterior, esta lista de condiciones y la siguiente exención de responsabilidad en la documentación y/u otros materiales proporcionados con la distribución.
Este software es proporcionado por los titulares de derechos de autor y contribuyentes "tal cual" y se rechaza cualquier garantía expresa o implícita, incluidas, entre otras, las garantías implícitas de comerciabilidad e idoneidad para un propósito particular. En ningún caso el propietario de los derechos de autor o los contribuyentes serán responsables de ningún daño directo, indirecto, incidental, especial, ejemplar o consecuente (incluido, entre otros, la adquisición de bienes o servicios sustitutos; pérdida de uso, datos o ganancias; o pérdida de negocios). ) interrupción) y cualquier teoría de responsabilidad, ya sea por contrato, responsabilidad estricta o agravio (incluyendo negligencia o de otro tipo) que surja del uso del Software, incluso si se le ha advertido de la posibilidad de tales daños.