File tree Expand file tree Collapse file tree 3 files changed +48
-1
lines changed
source/content/pages/06-apis Expand file tree Collapse file tree 3 files changed +48
-1
lines changed Original file line number Diff line number Diff line change @@ -75,6 +75,26 @@ <h2>API creation resources</h2>
7575 is an interesting overview of the Python API frameworks space.</ p >
7676</ li >
7777</ ul >
78+ < h2 > API creation learning checklist</ h2 >
79+ < p > < i class ="fa fa-check-square-o "> </ i >
80+ Pick an API framework appropriate for your web framework. For Django I
81+ recommend Django REST framework and for Flask I recommend Flask-RESTful.</ p >
82+ < p > < i class ="fa fa-check-square-o "> </ i >
83+ Begin by building out a simple use case for the API. Generally the use case
84+ will either involve data that users want in a machine-readable format or a
85+ backend for alternative clients such as an iOS or Android mobile app.</ p >
86+ < p > < i class ="fa fa-check-square-o "> </ i >
87+ Add an authentication mechanism through OAuth or a token scheme.</ p >
88+ < p > < i class ="fa fa-check-square-o "> </ i >
89+ Add rate limiting to the API if data usage volume could be a performance issue.
90+ Also add basic metrics so you can determine how often the API is being
91+ accessed and whether it is performing properly.</ p >
92+ < p > < i class ="fa fa-check-square-o "> </ i >
93+ Provide ample documentation and a walkthrough for how the API can be accessed
94+ and used.</ p >
95+ < p > < i class ="fa fa-check-square-o "> </ i >
96+ Figure out other use cases and expand based on what you learned with the
97+ initial API use case.</ p >
7898< h3 > What's next after building an API for your web app?</ h3 >
7999 < div class ="row ">
80100 < div class ="col-md-3 ">
Original file line number Diff line number Diff line change 11<?xml version =" 1.0" encoding =" utf-8"
2- <feed xmlns =" http://www.w3.org/2005/Atom" title >Matt Makai</title ><link href =" http://www.fullstackpython.com/" rel =" alternate" link ><link href =" http://www.fullstackpython.com/feeds/all.atom.xml" rel =" self" link ><id >http://www.fullstackpython.com/</id ><updated >2014-05-27T07:15:49Z </updated ></feed >
2+ <feed xmlns =" http://www.w3.org/2005/Atom" title >Matt Makai</title ><link href =" http://www.fullstackpython.com/" rel =" alternate" link ><link href =" http://www.fullstackpython.com/feeds/all.atom.xml" rel =" self" link ><id >http://www.fullstackpython.com/</id ><updated >2014-05-28T08:53:23Z </updated ></feed >
Original file line number Diff line number Diff line change @@ -47,4 +47,31 @@ applications through machine-to-machine communication.
4747 is an interesting overview of the Python API frameworks space.
4848
4949
50+ ## API creation learning checklist
51+ <i class =" fa fa-check-square-o " ></i >
52+ Pick an API framework appropriate for your web framework. For Django I
53+ recommend Django REST framework and for Flask I recommend Flask-RESTful.
54+
55+ <i class =" fa fa-check-square-o " ></i >
56+ Begin by building out a simple use case for the API. Generally the use case
57+ will either involve data that users want in a machine-readable format or a
58+ backend for alternative clients such as an iOS or Android mobile app.
59+
60+ <i class =" fa fa-check-square-o " ></i >
61+ Add an authentication mechanism through OAuth or a token scheme.
62+
63+ <i class =" fa fa-check-square-o " ></i >
64+ Add rate limiting to the API if data usage volume could be a performance issue.
65+ Also add basic metrics so you can determine how often the API is being
66+ accessed and whether it is performing properly.
67+
68+ <i class =" fa fa-check-square-o " ></i >
69+ Provide ample documentation and a walkthrough for how the API can be accessed
70+ and used.
71+
72+ <i class =" fa fa-check-square-o " ></i >
73+ Figure out other use cases and expand based on what you learned with the
74+ initial API use case.
75+
76+
5077### What's next after building an API for your web app?
You can’t perform that action at this time.
0 commit comments