toranb / ember-data-django-rest-adapter

An ember-data adapter for django web applications powered by the django-rest-framework
MIT License
153 stars 26 forks source link

Clarifications #90

Closed cancan101 closed 10 years ago

cancan101 commented 10 years ago

Could you clarify what is meant by "The default ember-data RESTAdapter does not follow the conventions used by the django rest framework"?

Also, I assume that the adapter will not work with nested routers (see for example: https://github.com/alanjds/drf-nested-routers) if the update/delete/get are nested?

What is the reason that you must "have 2 different endpoints per django model"? Won't the API in the example here be the same whether or not you have two end points or use a viewset?

class People(generics.ListCreateAPIView):
    model = Person
    serializer_class = PersonSerializer

class Person(generics.RetrieveUpdateDestroyAPIView):
    model = Person
    serializer_class = PersonSerializer

urlpatterns = patterns('',
    url(r'^/people/(?P<pk>\d+)/$', Person.as_view()),
    url(r'^/people/$', People.as_view()),
)
dustinfarris commented 10 years ago

@cancan101:

@toranb: the README is getting pretty long and potentially confusing, we may want to consider revising it and maybe move some of it to a wiki

/cc @craigteegarden

toranb commented 10 years ago

I couldn't agree more - it's grown a bit over time as you know :)

Do you know of a good example OSS project that does this well? what external resource do people want to see used here? is "readthedocs" still a thing? do you guys like/want to use it or something else?

dustinfarris commented 10 years ago

I think Sphinx + RTD is better suited for Python projects, although I have seen it used in other domains.

It lately seems popular to leverage GitHub Pages for this sort of thing. We would have to decide on a domain name to use. The ember-cli documentation is a good example: iamstef.net/ember-cli/

We could always use GitHub's Wiki service.

dustinfarris commented 10 years ago

I have cleaned up the README and moved a lot of the information to the wiki. Installation/Usage info should be easier to consume now.