sollievo è un'applicazione conforme Django per Representational State Transfer (REST).
Utilizzo
Primer
Sollievo è influenzato da Ruby on Rails, ma nello spirito di Python non è così "magia". Sarà, tuttavia, risparmiare un sacco di codice:
# News / models.py
da modelli di importazione django.db
classe Article (models.Model):
& Nbsp; title = models.CharField (max_length = 255)
& Nbsp; content = models.TextField ()
& Nbsp; pubblicato = True
& Nbsp; created_at = models.DateTimeField (auto_now_add = True)
# News / urls.py
da django.conf.urls.defaults importare *
da risorsa import respite.urls
dalle viste importazione degli articoli
urlpatterns = risorsa (
& Nbsp; prefix = 'news / articoli',
& Nbsp; view = degli articoli
)
# News / views.py
da tregua import View
da modelli di importazione Articolo
degli articoli di classe (Visualizza):
& Nbsp; il modello = Articolo
& Nbsp; template_path = 'news / articoli'
& nbsp; supported_formats = ['html', 'json']
# templates / news / articoli / index.html


& Nbsp;
& Nbsp;
& Nbsp;
& Nbsp;
& Nbsp; {% per l'articolo in articoli%}
& Nbsp;

& Nbsp;

{{ARTICLE.TITLE}}

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

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

& Nbsp;

& Nbsp; {% endfor%}
& Nbsp;

# templates / news / articoli / index.json
# ...
Azioni predefinite
Vedi la classe di sollievo definisce le azioni per la visualizzazione e la manipolazione istanze modello; indice, spettacolo, nuovo, creare, modificare e sbquo; aggiornare e distruggere.
HTTP metodo HTTP percorso Funzione Scopo
GET articoli / index Render un elenco di articoli
GET articoli / Nuovo Nuovo rendering di un modulo per creare un nuovo articolo
Articoli POST / Crea Crea un nuovo articolo
GET articoli / 1 spettacolo Render un articolo specifico
GET articoli / 1 / edit rendere un form per modificare un articolo specifico
Articoli PUT / 1 update modificare un articolo specifico
DELETE articoli / 1 distruggono Eliminare un articolo specifico
In poche parole, Respite offre una collezione di caratteristiche che probabilmente necessari per la maggior parte dei vostri modelli e li indirizza restfully. È possibile annullare una o tutte queste funzioni e personalizzare come vuoi. Ad esempio, è possibile solo elencare gli articoli che sono stati pubblicati:
# News / views.py
degli articoli di classe (Visualizza):
& Nbsp; il modello = Articolo
& Nbsp; template_path = 'news / articoli'
& nbsp; supported_formats = ['html', 'json']
& Nbsp; def index (auto, richiesta):
& Nbsp; articoli = self.model.objects.filter (pubblicato = True)
& Nbsp; ritorno self._render (
& Nbsp; richiesta = richiesta,
& Nbsp; 'index' template =,
& Nbsp; context = {
& nbsp; 'articoli': articoli,
& Nbsp;},
& Nbsp; status = 200
& Nbsp;)
Si può anche omettere una o più delle azioni predefinite del tutto. Ad esempio, è possibile solo l'attuazione delle azioni indice e spettacolo:
# News / urls.py
da django.conf.urls.defaults importare *
da risorsa import respite.urls
dalle viste importazione degli articoli
urlpatterns = risorsa (
& Nbsp; prefix = 'news / articoli',
& Nbsp; view = degli articoli,
& Nbsp; azioni = ['index', 'show']
)
Le azioni personalizzate
Non si sono limitati a sette azioni predefinite di Tregua; è possibile aggiungere qualsiasi numero di azioni personalizzate e instradarli come più vi piace:
# News / urls.py
da django.conf.urls.defaults importare *
da respite.urls importare risorse, azione
dalle viste importazione degli articoli
urlpatterns = risorsa (
& Nbsp; prefix = 'news / articoli',
& Nbsp; view = degli articoli,
& nbsp; custom_actions = [
& Nbsp; azione (
& Nbsp; regex = r '(? P [0-9] +).? / Preview [a-zA-Z] * $',
& Nbsp; la funzione = 'preview',
& Nbsp; metodi = ['GET'],
& Nbsp; name = 'preview_news_article'
& Nbsp;)
& Nbsp;]
)
# News / views.py
da tregua import View
da modelli di importazione Articolo
degli articoli di classe (Visualizza):
& Nbsp; il modello = Articolo
& Nbsp; template_path = 'news / articoli'
& nbsp; supported_formats = ['html', 'json']
& Nbsp; anteprima def (self, richiesta, id):
& Nbsp; article = Article.objects.get (id = id)
& Nbsp; ritorno self._render (
& Nbsp; richiesta = richiesta,
& Nbsp; template = 'preview',
& Nbsp; context = {
& Nbsp; 'articolo': articolo
& Nbsp;},
& Nbsp; status = 200
& Nbsp;)
Installazione
- Pip installare git + http: //github.com/jgorset/respite.git
- Aggiungi tregua al INSTALLED_APPS nel file di impostazioni
- Aggiungi respite.middleware.HTTPPUTMiddleware al MIDDLEWARE_CLASSES nel file di impostazioni
Se non sei solo costruendo una API, si potrebbe anche voler aggiungere respite.middleware.HTTPMethodOverrideMiddleware alle classi middleware; facilita per l'override del metodo HTTP con l'intestazione X-HTTP-Metodo-override o un parametro POST _method HTTP, che è l'unico modo per aggiornare (PUT HTTP) ed eliminare (HTTP DELETE) le risorse da un browser web.

Requisiti :

• Python
• Django