Skip to content

Commit 1fc8dbf

Browse files
mattmakaimattmakai
committed
adding leanring checklist for api integration
1 parent 10e2de9 commit 1fc8dbf

File tree

7 files changed

+53
-5
lines changed

7 files changed

+53
-5
lines changed

‎api-integration.html‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,27 @@ <h2>API Integration Resources</h2>
8686
"<a href="http://www.youtube.com/watch?v=iGP8DQIqxXs">Making Django Play Nice With Third Party Services</a>."</p>
8787
</li>
8888
</ul>
89+
<h2>API integration learning checklist</h2>
90+
<p><i class="fa fa-check-square-o"></i>
91+
Pick an API known for top notch documentation. Here's a list of
92+
<a href="https://medium.com/she-hacks-hacker-academy/4d3c43be9386">ten APIs that are a good starting point for beginners</a>.</p>
93+
<p><i class="fa fa-check-square-o"></i>
94+
Read the API documentation for your chosen API. Figure out a simple use case
95+
for how your application could be improved by using that API.</p>
96+
<p><i class="fa fa-check-square-o"></i>
97+
Before you start writing any code, play around with the API through the
98+
commandline with <a href="http://curl.haxx.se/">curl</a> or in the browser with
99+
<a href="http://www.getpostman.com/">Postman</a>. This exercise will help you get a
100+
better understanding of API authentication and the data required for requests
101+
and responses.</p>
102+
<p><i class="fa fa-check-square-o"></i>
103+
Evaluate whether to use a helper library or work with
104+
<a href="http://docs.python-requests.org/en/latest/">Requests</a>. Helper libraries are
105+
usually easier to get started with while Requests gives you more control over
106+
the HTTP calls.</p>
107+
<p><i class="fa fa-check-square-o"></i>
108+
Move your API calls into a <a href="/task-queues.html">task queue</a> so they do not
109+
block the HTTP request-response cycle for your web application.</p>
89110
<h3>What's next after integrating APIs into your app?</h3>
90111
<div class="row">
91112
<div class="col-md-3">

‎change-log.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ <h3>May</h3>
5151
developer capabilities.</li>
5252
<li>Updated APIs page with basic information on webhooks.</li>
5353
<li>Added learning checklist for source control, application dependencies,
54-
configuration management, NoSQL data stores and APIs.</li>
54+
configuration management, NoSQL data stores, APIs and API integration.</li>
5555
<li>Moving learning checklists to the bottom of the pages since they are
5656
specific advice for steps to take after reading a section.</li>
5757
<li>Added a stub section for APIs.</li>

‎feeds/all.atom.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
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:01:32Z</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-27T07:15:49Z</updated></feed>

‎future-directions.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ <h1>Future Directions</h1>
7070
<p>Create learning checklists for every section where it makes sense. The
7171
remaining sections that need checklists are </p>
7272
<ol>
73-
<li>API integration</li>
73+
<li>API creation</li>
7474
<li>static content</li>
7575
<li>caching</li>
7676
<li>logging</li>

‎source/content/pages/06-apis/0603-api-integration.markdown‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,4 +58,31 @@ across many implementation areas.
5858
"[Making Django Play Nice With Third Party Services](http://www.youtube.com/watch?v=iGP8DQIqxXs)."
5959

6060

61+
## API integration learning checklist
62+
<i class="fa fa-check-square-o"></i>
63+
Pick an API known for top notch documentation. Here's a list of
64+
[ten APIs that are a good starting point for beginners](https://medium.com/she-hacks-hacker-academy/4d3c43be9386).
65+
66+
<i class="fa fa-check-square-o"></i>
67+
Read the API documentation for your chosen API. Figure out a simple use case
68+
for how your application could be improved by using that API.
69+
70+
<i class="fa fa-check-square-o"></i>
71+
Before you start writing any code, play around with the API through the
72+
commandline with [curl](http://curl.haxx.se/) or in the browser with
73+
[Postman](http://www.getpostman.com/). This exercise will help you get a
74+
better understanding of API authentication and the data required for requests
75+
and responses.
76+
77+
<i class="fa fa-check-square-o"></i>
78+
Evaluate whether to use a helper library or work with
79+
[Requests](http://docs.python-requests.org/en/latest/). Helper libraries are
80+
usually easier to get started with while Requests gives you more control over
81+
the HTTP calls.
82+
83+
<i class="fa fa-check-square-o"></i>
84+
Move your API calls into a [task queue](/task-queues.html) so they do not
85+
block the HTTP request-response cycle for your web application.
86+
87+
6188
### What's next after integrating APIs into your app?

‎source/content/pages/10-misc/1005-change-log.markdown‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ the
2828
developer capabilities.
2929
* Updated APIs page with basic information on webhooks.
3030
* Added learning checklist for source control, application dependencies,
31-
configuration management, NoSQL data stores and APIs.
31+
configuration management, NoSQL data stores, APIs and API integration.
3232
* Moving learning checklists to the bottom of the pages since they are
3333
specific advice for steps to take after reading a section.
3434
* Added a stub section for APIs.

‎source/content/pages/10-misc/1007-future-directions.markdown‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Here are some things I'm actively working on:
4646
* Create learning checklists for every section where it makes sense. The
4747
remaining sections that need checklists are
4848

49-
1. API integration
49+
1. API creation
5050
1. static content
5151
1. caching
5252
1. logging

0 commit comments

Comments
 (0)