Re: Structuring an API in a large project

On 2/05/2014 2:16 AM, Adam "Cezar" Jenkins wrote:
> On Thu, May 1, 2014 at 11:10 AM, Venkatraman S <venkat83@gmail.com
> <mailto:venkat83@gmail.com>> wrote:
>
>
>
> On Thu, May 1, 2014 at 9:29 PM, Cezar Jenkins
> <emperorcezar@gmail.com <mailto:emperorcezar@gmail.com>> wrote:
>
> Right now I have a large project with an equally large API (done
> using django rest framework). The current structure is something
> like this:
>
> api
> |-----urls.py
> |-----models.py
> |
> ----v1
> Â Â |-----views.py
> Â Â |-----serializers.py
> Â Â |-----permissions.py
> Â Â |-----tests.py
>
> etc
>
> As you can guess, the views.py file is pretty big and I want to
> refactor this out. Currently I have a few options in front of
> me, the one I'm leaning towards is to put an 'api/v1' package
> into each app and use the api app to tie all the urls together
> and hold views that don't fall into an app.
>
>
> If the only pain point is the big views file, then why not just
> refactor that into multiple files under 'v1' Â itself - nothing is
> stopping you from doing that.Â
>
>
> That was one way I started refactoring, but ran into issues. Say I have
> a destinations.py view file in the api, but I also have a destinations
> app. In my views file I can't do 'from destinations.models import
> Destination' cause the name conflicts. So I started having to name
> things 'destinations_api.py' which seemed really dirty.

I might have missed something here but the usual Django way of
refactoring a large views (models too) file is to convert it into a
directory containing a file for each view. Then you can still refer to
each view using the dotted names as previously. No need to change other
code in other parts of the app which calls them.

> Â
>
> --
> You received this message because you are subscribed to a topic in
> the Google Groups "Django users" group.
> To unsubscribe from this topic, visit
> https://groups.google.com/d/topic/django-users/rizwdsi5o1k/unsubscribe.
> To unsubscribe from this group and all its topics, send an email to
> django-users+unsubscribe@googlegroups.com
> <mailto:django-users+unsubscribe@googlegroups.com>.
> To post to this group, send email to django-users@googlegroups.com
> <mailto:django-users@googlegroups.com>.
> Visit this group at http://groups.google.com/group/django-users.
> To view this discussion on the web visit
> https://groups.google.com/d/msgid/django-users/CAN7tdFT0BAG5XoKoiavKr7v24DqSQTc7D%2Bq5EY7Wgoh_VzvzeA%40mail.gmail.com
> <https://groups.google.com/d/msgid/django-users/CAN7tdFT0BAG5XoKoiavKr7v24DqSQTc7D%2Bq5EY7Wgoh_VzvzeA%40mail.gmail.com?utm_medium=email&utm_source=footer>.
>
> For more options, visit https://groups.google.com/d/optout.
>
>
> --
> You received this message because you are subscribed to the Google
> Groups "Django users" group.
> To unsubscribe from this group and stop receiving emails from it, send
> an email to django-users+unsubscribe@googlegroups.com
> <mailto:django-users+unsubscribe@googlegroups.com>.
> To post to this group, send email to django-users@googlegroups.com
> <mailto:django-users@googlegroups.com>.
> Visit this group at http://groups.google.com/group/django-users.
> To view this discussion on the web visit
> https://groups.google.com/d/msgid/django-users/CAN6vQqtUML2-o3pkx02o%2BnsZ0nnYCUC6XULjw--MdRwRyOcsdg%40mail.gmail.com
> <https://groups.google.com/d/msgid/django-users/CAN6vQqtUML2-o3pkx02o%2BnsZ0nnYCUC6XULjw--MdRwRyOcsdg%40mail.gmail.com?utm_medium=email&utm_source=footer>.
> For more options, visit https://groups.google.com/d/optout.

--
You received this message because you are subscribed to the Google Groups "Django users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to django-users+unsubscribe@googlegroups.com.
To post to this group, send email to django-users@googlegroups.com.
Visit this group at http://groups.google.com/group/django-users.
To view this discussion on the web visit https://groups.google.com/d/msgid/django-users/5362CC50.5060905%40dewhirst.com.au.
For more options, visit https://groups.google.com/d/optout.