Building a GraphQL API with DJango

Slides from the Tutorial at DjangoCon 2017

Transcript

1. Building A GraphQL API Using Django James Muranga
2. Developer at ThoughtWorks @murangajames dev@mjamo.com PLEASE SHARE ANY FEEDBACK YOU HAVE FOR ME
3. Building A GraphQL API Using Django
4. AGENDA •What is GraphQL •Why? •Graphene ? •Django App
5. SETUP •Python •An Editor (VSCode, Atom, PyCharm etc) •Starter project http://bit.ly/2fCLUGp FEEL FREE TO INTERRUPT AND ASK QUESTIONS
6. GraphQL A Query Language for APIs
7. Defines shape of Data Hierarchical Strongly typed Protocol Introspective
8. Defines shape of Data Hierarchical Strongly typed Protocol Introspective
9. Defines shape of Data Hierarchical Strongly typed Protocol Introspective
10. Defines shape of Data Hierarchical Strongly typed Protocol Introspective
11. Defines shape of Data Hierarchical Strongly typed Protocol Introspective
12. Why GraphQL ?
13. •REST •SOAP •JSON RPC •… What else is there ?
14. RESTFUL API FOR “SOME APP” •List of Users •Each User has notes •Each Notes has revisions
15. GET https://api.someapp.com/api/v1/users [ { "id": "2016", "name": "The one who cant be named", "notes": [ { "id": "2015", "content": "The friend", "revision": "1", "size": 108, "topics": [ "octocat", "atom", "electron", "API" ], "has_issues": true, "has_wiki": true, "has_pages": false, "has_downloads": true, "pushed_at": "2011-01-26T19:06:43Z", "created_at": "2011-01-26T19:01:12Z", "updated_at": "2011-01-26T19:14:43Z", "permissions": { "admin": false, "push": false, "pull": true }, "subscribers_count": 42, "network_count": 0 } ] }
16. REQUESTS ARE HUGE !!!
17. GET https://api.someapp.com/api/v2/users [ { "id": "2016", "name": "The one who cant be named", "notes": "https://api.app.com/api/users/2016/notes" } ] GET https://api.someapp.com/api/v2/users/2016/notes [ { "id": "2015", "content": "The friend", "revision": "1", "size": 108, "topics": [ "octocat",
18. REQUESTS ARE MANY !!!
19. Request Response
20. Graphene an example implementation in Python
21. SCHEMA QUERY MUTATION
25. SCHEMA QUERY MUTATION
26. SCHEMA QUERY MUTATION
28. GRAPHENE DEMO http://bit.ly/2fCLUGp
29. Polls App • Setup • Walkthrough the App • Add Schema • Browse GraphiQL • Write Tests • Add mutation • Write more tests • Handle Users • Questions
30. SETUP •Python •An Editor (VSCode, Atom, PyCharm etc) •Starter project http://bit.ly/2fCLUGp FEEL FREE TO INTERRUPT AND ASK QUESTIONS
31. Debug GRAPHENE = { 'SCHEMA': 'polls.schema.schema', 'MIDDLEWARE': [ 'graphene_django.debug.DjangoDebugMiddleware', ] } debug = graphene.Field(DjangoDebug,name='__debug')
32. Schema ./manage.py graphql_schema —schema out.json
33. Users
34. http://graphene-python.org/ http://graphql.org/
35. GraphQL is just another tool