relevo es una aplicación que se ajuste a Django Transferencia de estado representacional (REST).
Uso
Cartilla
Respiro está influenciada por Ruby on Rails, aunque en el espíritu de Python no es tan "mágico". Será, sin embargo, le ahorrará una gran cantidad de código:
# Noticias / models.py
a partir de modelos de importación django.db
clase Article (models.Model):
& Nbsp; title = models.CharField (max_length = 255)
& Nbsp; content = models.TextField ()
& Nbsp; publicada = True
& Nbsp; created_at = models.DateTimeField (auto_now_add = True)
# Noticias / urls.py
desde django.conf.urls.defaults importar *
desde respite.urls recurso importación
desde puntos de vista ArticleView importación
urlpatterns = recurso (
& Nbsp; prefix = "noticias / artículos ',
& Nbsp; view = ArticleView
)
# Noticias / views.py
de respiro importación Ver
a partir de modelos de importación Artículo
ArticleView clase (Ver):
& Nbsp; model = artículo
& Nbsp; template_path = 'noticias / artículos'
& nbsp; supported_formats = ['html', 'json']
# templates / noticias / artículos / index.html


& Nbsp;
& Nbsp;
& Nbsp;
& Nbsp;
& Nbsp; {% por artículo en artículos%}
& Nbsp;

& Nbsp;

{{articulo.titulo}}

& Nbsp; {{}} article.created_at
& Nbsp;

& Nbsp; {{}} article.content
& Nbsp;

& Nbsp;

& Nbsp; {% endfor%}
& Nbsp;

# templates / noticias / artículos / index.json
# ...
Acciones predeterminadas
Ver la clase de Respiro define acciones para ver y manipular instancias de modelo; índice, demostración, nuevo, crear, editar y sbquo; actualizar y destruir.
HTTP método HTTP trayectoria Función Propósito
GET artículos / index Render una lista de artículos
Reciba artículos / nueva nuevas Render un formulario para crear un nuevo artículo
Artículos de POST / Crear Crear artículo
GET artículos / 1 muestran Render un artículo específico
GET artículos / 1 / edit Render una forma de editar un artículo específico
Artículos PUT / 1 actualización Editar un artículo específico
Suprimir los artículos / 1 destruyen Eliminar un artículo específico
En pocas palabras, de relevo le proporciona un conjunto de características que usted probablemente necesita para la mayoría de sus modelos y las encamina REST. Puede anular cualquiera o todas estas funciones y personalizarlos como desee. Por ejemplo, sólo se podría hacer una lista de artículos que se han publicado:
# Noticias / views.py
ArticleView clase (Ver):
& Nbsp; model = artículo
& Nbsp; template_path = 'noticias / artículos'
& nbsp; supported_formats = ['html', 'json']
& Nbsp; def índice (self, petición):
& Nbsp; articulos = self.model.objects.filter (publicado = True)
& Nbsp; retorno self._render (
& Nbsp; request = solicitud,
& Nbsp; 'índice' plantilla =,
& Nbsp; context = {
& nbsp; "artículos": artículos,
& Nbsp;},
& Nbsp; estado = 200
& Nbsp;)
También puede omitir una o varias de las acciones predeterminadas por completo. Por ejemplo, sólo se podía poner en práctica las acciones indexar y mostrar:
# Noticias / urls.py
desde django.conf.urls.defaults importar *
desde respite.urls recurso importación
desde puntos de vista ArticleView importación
urlpatterns = recurso (
& Nbsp; prefix = "noticias / artículos ',
& Nbsp; view = ArticleView,
& Nbsp; acciones = ['índice', 'show']
)
Las acciones personalizadas
Usted no está limitado a siete acciones predefinidas de relevo; usted puede agregar cualquier número de acciones personalizadas y encaminarlos como más te guste:
# Noticias / urls.py
desde django.conf.urls.defaults importar *
desde respite.urls importar recursos, acción
desde puntos de vista ArticleView importación
urlpatterns = recurso (
& Nbsp; prefix = "noticias / artículos ',
& Nbsp; view = ArticleView,
& nbsp; custom_actions = [
& Nbsp; la acción (
& Nbsp; regex = r '(? P [0-9] +).? / Previsualización [a-zA-Z] * $',
& Nbsp; la función = 'vista previa',
& Nbsp; métodos = ['GET'],
& Nbsp; name = 'preview_news_article'
& Nbsp;)
& Nbsp;]
)
# Noticias / views.py
de respiro importación Ver
a partir de modelos de importación Artículo
ArticleView clase (Ver):
& Nbsp; model = artículo
& Nbsp; template_path = 'noticias / artículos'
& nbsp; supported_formats = ['html', 'json']
& Nbsp; previsualización def (self, solicitud, id):
& Nbsp; article = Article.objects.get (id = id)
& Nbsp; retorno self._render (
& Nbsp; request = solicitud,
& Nbsp; template = 'vista previa',
& Nbsp; context = {
& Nbsp; «artículo»: artículo
& Nbsp;},
& Nbsp; estado = 200
& Nbsp;)
Instalación
- Pip instalar git + http: //github.com/jgorset/respite.git
- Añadir respiro a INSTALLED_APPS en su archivo de configuración
- Añadir respite.middleware.HTTPPUTMiddleware a MIDDLEWARE_CLASSES en su archivo de configuración
Si usted no está sólo la construcción de una API, es posible que también desee agregar respite.middleware.HTTPMethodOverrideMiddleware a sus clases de middleware; facilita para anular el método HTTP con el encabezado X-HTTP-Method-Anular o un parámetro HTTP POST _method, que es la única forma de actualizar (HTTP PUT) y eliminar (HTTP DELETE) los recursos de un navegador web.

Requisitos :

• Python
• Django