Aflastning er en app, der overholder Django til REST (REST).
Anvendelse
Primer
Pusterum påvirkes af Ruby on Rails, men i ånd Python er det ikke nær så "magisk". Det vil dog spare dig for en masse kode:
# News / models.py
fra django.db import- modeller
class artikel (models.Model):
& Nbsp; title = models.CharField (MAX_LENGTH = 255)
& Nbsp; content = models.TextField ()
& Nbsp; offentliggjort = True
& Nbsp; created_at = models.DateTimeField (auto_now_add = True)
# News / urls.py
fra django.conf.urls.defaults importerer *
fra respite.urls import ressource
fra visninger import ArticleView
urlpatterns = ressource (
& Nbsp; præfiks = 'nyheder / Artikler «,
& Nbsp; view = ArticleView
)
# News / views.py
fra pusterum import View
fra modeller import artikel
klasse ArticleView (View):
& Nbsp; model = artikel
& Nbsp; template_path = 'nyheder / Artikler'
& nbsp; supported_formats = ['html', 'JSON']
# templates / nyheder / Artikler / index.html


& Nbsp;
& Nbsp;
& Nbsp;
& Nbsp;
& Nbsp; {% for artikel i artikler%}
& Nbsp;

& Nbsp;

{{article.title}}

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

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

& Nbsp;

& Nbsp; {% EndFor%}
& Nbsp;

# templates / nyheder / Artikler / index.json
# ...
Standard aktioner
Pusterum visning klasse definerer handlinger for visning og manipulere model forekomster; indeks, show, nye, oprette, redigere & sbquo; opdatere og ødelægge.
HTTP metode HTTP sti Formål
GET artikler / indeks Render en liste over artikler
GET artikler / nye ny Render en formular for at oprette en ny artikel
POST articles / Opret Opret en ny artikel
GET artikler / 1 viser Render en specifik artikel
GET artikler / 1 / Rediger Rediger Render en formular til at redigere en specifik artikel
PUT articles / 1 update Rediger en specifik artikel
DELETE artikler / 1 ødelægge Slet en specifik artikel
I en nøddeskal, Aflastning giver dig en samling af funktioner, du sandsynligvis brug for de fleste af dine modeller og ruter dem restfully. Du kan tilsidesætte en eller alle disse funktioner og tilpasse dem som du gerne vil. For eksempel kan du kun vise artikler, der er blevet offentliggjort:
# News / views.py
klasse ArticleView (View):
& Nbsp; model = artikel
& Nbsp; template_path = 'nyheder / Artikler'
& nbsp; supported_formats = ['html', 'JSON']
& Nbsp; def indeks (selv, anmodning):
& Nbsp; artikler = self.model.objects.filter (offentliggjort = True)
& Nbsp; tilbagevenden self._render (
& Nbsp; anmodning = anmodning,
& Nbsp; skabelon = "indeks",
& Nbsp; context = {
& nbsp; "artikler": artikler,
& Nbsp;},
& Nbsp; status = 200
& Nbsp;)
Du kan også udelade en eller flere af de standard handlinger helt. For eksempel kan du kun gennemføre indeks og vise handlinger:
# News / urls.py
fra django.conf.urls.defaults importerer *
fra respite.urls import ressource
fra visninger import ArticleView
urlpatterns = ressource (
& Nbsp; præfiks = 'nyheder / Artikler «,
& Nbsp; view = ArticleView,
& Nbsp; tiltag = ['indeks', 'show']
)
Tilpassede aktioner
Du er ikke begrænset til Respite syv foruddefinerede handlinger; du kan tilføje et vilkårligt antal brugerdefinerede handlinger og rute dem, som du vil:
# News / urls.py
fra django.conf.urls.defaults importerer *
fra respite.urls importerer ressourcer, handling
fra visninger import ArticleView
urlpatterns = ressource (
& Nbsp; præfiks = 'nyheder / Artikler «,
& Nbsp; view = ArticleView,
& nbsp; custom_actions = [
& Nbsp; handling (
& Nbsp; regex = R '(? P [0-9] +).? / Forhåndsvisning [a-zA-Z] * $',
& Nbsp; funktion = 'Preview',
& Nbsp; metoder = ['GET'],
& Nbsp; name = "preview_news_article '
& Nbsp;)
& Nbsp;]
)
# News / views.py
fra pusterum import View
fra modeller import artikel
klasse ArticleView (View):
& Nbsp; model = artikel
& Nbsp; template_path = 'nyheder / Artikler'
& nbsp; supported_formats = ['html', 'JSON']
& Nbsp; def forhåndsvisning (selv, anmodning, id):
& Nbsp; artikel = Article.objects.get (id = id)
& Nbsp; tilbagevenden self._render (
& Nbsp; anmodning = anmodning,
& Nbsp; skabelon = 'Preview',
& Nbsp; context = {
& Nbsp; "artikel": Artikel
& Nbsp;},
& Nbsp; status = 200
& Nbsp;)
Installation
- Pip installere git + http: //github.com/jgorset/respite.git
- Føj pusterum til INSTALLED_APPS i din indstillingsfil
- Føj respite.middleware.HTTPPUTMiddleware til MIDDLEWARE_CLASSES i din indstillingsfil
Hvis du ikke bare at bygge en API, kan du også ønsker at tilføje respite.middleware.HTTPMethodOverrideMiddleware til dine middleware klasser; det letter at suspendere en HTTP-metoden med X-HTTP-metode-Override sidehoved eller en _method HTTP POST parameter, som er den eneste måde at opdatere (HTTP PUT) og slet (HTTP SLET) ressourcer fra en webbrowser.

Krav :

• Python
• Django