Skip to content

Commit b579254

Browse files
mattmakaimattmakai
committed
fixing api pages
1 parent 65aee07 commit b579254

11 files changed

+193
-163
lines changed

‎all.html‎

Lines changed: 74 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -3330,18 +3330,25 @@ <h2>API resources</h2>
33303330
</li>
33313331
</ul>
33323332
<h2>APIs learning checklist</h2>
3333-
<p><i class="fa fa-check-square-o"></i>
3334-
Learn the API concepts of machine-to-machine communication with JSON and XML,
3335-
endpoints and webhooks.</p>
3336-
<p><i class="fa fa-check-square-o"></i>
3337-
Integrate an API such as Twilio or Stripe into your web application. Read the
3338-
<a href="/api-integration.html">API integration</a> section for more information.</p>
3339-
<p><i class="fa fa-check-square-o"></i>
3340-
Use a framework to create an API for your own application. </p>
3341-
<p><i class="fa fa-check-square-o"></i>
3342-
Expose your web application's API so other applications can consume data you
3343-
want to share.</p>
3344-
<h3>What's next after learning about APIs?</h3>
3333+
<ol>
3334+
<li>
3335+
<p>Learn the API concepts of machine-to-machine communication with JSON and
3336+
XML, endpoints and webhooks.</p>
3337+
</li>
3338+
<li>
3339+
<p>Integrate an API such as Twilio or Stripe into your web application.
3340+
Read the <a href="/api-integration.html">API integration</a> section for more
3341+
information.</p>
3342+
</li>
3343+
<li>
3344+
<p>Use a framework to create an API for your own application. Learn about
3345+
web API frameworks on the <a href="/api-creation.html">API creation</a> page.</p>
3346+
</li>
3347+
<li>
3348+
<p>Expose your web application's API so other applications can consume data
3349+
you want to share.</p>
3350+
</li>
3351+
</ol>
33453352
<h1>API Integration</h1>
33463353
<p>The majority of production Python web applications rely on several
33473354
externally hosted application programming interfaces (APIs). APIs are also
@@ -3429,27 +3436,33 @@ <h2>API Integration Resources</h2>
34293436
</li>
34303437
</ul>
34313438
<h2>API integration learning checklist</h2>
3432-
<p><i class="fa fa-check-square-o"></i>
3433-
Pick an API known for top notch documentation. Here's a list of
3434-
<a href="https://medium.com/she-hacks-hacker-academy/4d3c43be9386">ten APIs that are a good starting point for beginners</a>.</p>
3435-
<p><i class="fa fa-check-square-o"></i>
3436-
Read the API documentation for your chosen API. Figure out a simple use case
3437-
for how your application could be improved by using that API.</p>
3438-
<p><i class="fa fa-check-square-o"></i>
3439-
Before you start writing any code, play around with the API through the
3440-
commandline with <a href="http://curl.haxx.se/">curl</a> or in the browser with
3441-
<a href="http://www.getpostman.com/">Postman</a>. This exercise will help you get a
3442-
better understanding of API authentication and the data required for requests
3443-
and responses.</p>
3444-
<p><i class="fa fa-check-square-o"></i>
3445-
Evaluate whether to use a helper library or work with
3446-
<a href="http://docs.python-requests.org/en/latest/">Requests</a>. Helper libraries are
3447-
usually easier to get started with while Requests gives you more control over
3448-
the HTTP calls.</p>
3449-
<p><i class="fa fa-check-square-o"></i>
3450-
Move your API calls into a <a href="/task-queues.html">task queue</a> so they do not
3451-
block the HTTP request-response cycle for your web application.</p>
3452-
<h3>What's next after integrating APIs into your app?</h3>
3439+
<ol>
3440+
<li>
3441+
<p>Pick an API known for top notch documentation. Here's a list of
3442+
<a href="https://medium.com/she-hacks-hacker-academy/4d3c43be9386">ten APIs that are a good starting point for beginners</a>.</p>
3443+
</li>
3444+
<li>
3445+
<p>Read the API documentation for your chosen API. Figure out a simple
3446+
use case for how your application could be improved by using that API.</p>
3447+
</li>
3448+
<li>
3449+
<p>Before you start writing any code, play around with the API through the
3450+
commandline with <a href="http://curl.haxx.se/">curl</a> or in the browser with
3451+
<a href="http://www.getpostman.com/">Postman</a>. This exercise will help you get
3452+
a better understanding of API authentication and the data required for
3453+
requests and responses.</p>
3454+
</li>
3455+
<li>
3456+
<p>Evaluate whether to use a helper library or work with
3457+
<a href="http://docs.python-requests.org/en/latest/">Requests</a>. Helper libraries
3458+
are usually easier to get started with while Requests gives you more
3459+
control over the HTTP calls.</p>
3460+
</li>
3461+
<li>
3462+
<p>Move your API calls into a <a href="/task-queues.html">task queue</a> so they do not
3463+
block the HTTP request-response cycle for your web application.</p>
3464+
</li>
3465+
</ol>
34533466
<h1>API Creation</h1>
34543467
<p>Creating and exposing APIs allows your web application to interact with other
34553468
applications through machine-to-machine communication.</p>
@@ -3629,26 +3642,34 @@ <h2>API creation resources</h2>
36293642
</li>
36303643
</ul>
36313644
<h2>API creation learning checklist</h2>
3632-
<p><i class="fa fa-check-square-o"></i>
3633-
Pick an API framework appropriate for your web framework. For Django I
3634-
recommend Django REST framework and for Flask I recommend Flask-RESTful.</p>
3635-
<p><i class="fa fa-check-square-o"></i>
3636-
Begin by building out a simple use case for the API. Generally the use case
3637-
will either involve data that users want in a machine-readable format or a
3638-
backend for alternative clients such as an iOS or Android mobile app.</p>
3639-
<p><i class="fa fa-check-square-o"></i>
3640-
Add an authentication mechanism through OAuth or a token scheme.</p>
3641-
<p><i class="fa fa-check-square-o"></i>
3642-
Add rate limiting to the API if data usage volume could be a performance issue.
3643-
Also add basic metrics so you can determine how often the API is being
3644-
accessed and whether it is performing properly.</p>
3645-
<p><i class="fa fa-check-square-o"></i>
3646-
Provide ample documentation and a walkthrough for how the API can be accessed
3647-
and used.</p>
3648-
<p><i class="fa fa-check-square-o"></i>
3649-
Figure out other use cases and expand based on what you learned with the
3650-
initial API use case.</p>
3651-
<h3>What's next after building an API for your web app?</h3>
3645+
<ol>
3646+
<li>
3647+
<p>Pick an API framework appropriate for your web framework. For Django I
3648+
recommend Django REST framework and for Flask I recommend Flask-RESTful.</p>
3649+
</li>
3650+
<li>
3651+
<p>Begin by building out a simple use case for the API. Generally the use
3652+
case will either involve data that users want in a machine-readable
3653+
format or a backend for alternative clients such as an iOS or Android
3654+
mobile app.</p>
3655+
</li>
3656+
<li>
3657+
<p>Add an authentication mechanism through OAuth or a token scheme.</p>
3658+
</li>
3659+
<li>
3660+
<p>Add rate limiting to the API if data usage volume could be a performance
3661+
issue. Also add basic metrics so you can determine how often the API is
3662+
being accessed and whether it is performing properly.</p>
3663+
</li>
3664+
<li>
3665+
<p>Provide ample documentation and a walkthrough for how the API can be
3666+
accessed and used.</p>
3667+
</li>
3668+
<li>
3669+
<p>Figure out other use cases and expand based on what you learned with the
3670+
initial API use case.</p>
3671+
</li>
3672+
</ol>
36523673
<h1>Deployment</h1>
36533674
<p>Deployment involves packaging up your web application and putting it in a
36543675
production environment that can run the app.</p>

‎api-creation.html‎

Lines changed: 29 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -213,26 +213,35 @@ <h2>API creation resources</h2>
213213
</li>
214214
</ul>
215215
<h2>API creation learning checklist</h2>
216-
<p><i class="fa fa-check-square-o"></i>
217-
Pick an API framework appropriate for your web framework. For Django I
218-
recommend Django REST framework and for Flask I recommend Flask-RESTful.</p>
219-
<p><i class="fa fa-check-square-o"></i>
220-
Begin by building out a simple use case for the API. Generally the use case
221-
will either involve data that users want in a machine-readable format or a
222-
backend for alternative clients such as an iOS or Android mobile app.</p>
223-
<p><i class="fa fa-check-square-o"></i>
224-
Add an authentication mechanism through OAuth or a token scheme.</p>
225-
<p><i class="fa fa-check-square-o"></i>
226-
Add rate limiting to the API if data usage volume could be a performance issue.
227-
Also add basic metrics so you can determine how often the API is being
228-
accessed and whether it is performing properly.</p>
229-
<p><i class="fa fa-check-square-o"></i>
230-
Provide ample documentation and a walkthrough for how the API can be accessed
231-
and used.</p>
232-
<p><i class="fa fa-check-square-o"></i>
233-
Figure out other use cases and expand based on what you learned with the
234-
initial API use case.</p>
235-
<h3>What's next after building an API for your web app?</h3>
216+
<ol>
217+
<li>
218+
<p>Pick an API framework appropriate for your web framework. For Django I
219+
recommend Django REST framework and for Flask I recommend Flask-RESTful.</p>
220+
</li>
221+
<li>
222+
<p>Begin by building out a simple use case for the API. Generally the use
223+
case will either involve data that users want in a machine-readable
224+
format or a backend for alternative clients such as an iOS or Android
225+
mobile app.</p>
226+
</li>
227+
<li>
228+
<p>Add an authentication mechanism through OAuth or a token scheme.</p>
229+
</li>
230+
<li>
231+
<p>Add rate limiting to the API if data usage volume could be a performance
232+
issue. Also add basic metrics so you can determine how often the API is
233+
being accessed and whether it is performing properly.</p>
234+
</li>
235+
<li>
236+
<p>Provide ample documentation and a walkthrough for how the API can be
237+
accessed and used.</p>
238+
</li>
239+
<li>
240+
<p>Figure out other use cases and expand based on what you learned with the
241+
initial API use case.</p>
242+
</li>
243+
</ol>
244+
<h3>What's next after building an API for your project?</h3>
236245
<div class="row">
237246
<div class="col-md-4">
238247
<div class="well select-next">

‎api-integration.html‎

Lines changed: 28 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -121,27 +121,34 @@ <h2>API Integration Resources</h2>
121121
</li>
122122
</ul>
123123
<h2>API integration learning checklist</h2>
124-
<p><i class="fa fa-check-square-o"></i>
125-
Pick an API known for top notch documentation. Here's a list of
126-
<a href="https://medium.com/she-hacks-hacker-academy/4d3c43be9386">ten APIs that are a good starting point for beginners</a>.</p>
127-
<p><i class="fa fa-check-square-o"></i>
128-
Read the API documentation for your chosen API. Figure out a simple use case
129-
for how your application could be improved by using that API.</p>
130-
<p><i class="fa fa-check-square-o"></i>
131-
Before you start writing any code, play around with the API through the
132-
commandline with <a href="http://curl.haxx.se/">curl</a> or in the browser with
133-
<a href="http://www.getpostman.com/">Postman</a>. This exercise will help you get a
134-
better understanding of API authentication and the data required for requests
135-
and responses.</p>
136-
<p><i class="fa fa-check-square-o"></i>
137-
Evaluate whether to use a helper library or work with
138-
<a href="http://docs.python-requests.org/en/latest/">Requests</a>. Helper libraries are
139-
usually easier to get started with while Requests gives you more control over
140-
the HTTP calls.</p>
141-
<p><i class="fa fa-check-square-o"></i>
142-
Move your API calls into a <a href="/task-queues.html">task queue</a> so they do not
143-
block the HTTP request-response cycle for your web application.</p>
144-
<h3>What's next after integrating APIs into your app?</h3>
124+
<ol>
125+
<li>
126+
<p>Pick an API known for top notch documentation. Here's a list of
127+
<a href="https://medium.com/she-hacks-hacker-academy/4d3c43be9386">ten APIs that are a good starting point for beginners</a>.</p>
128+
</li>
129+
<li>
130+
<p>Read the API documentation for your chosen API. Figure out a simple
131+
use case for how your application could be improved by using that API.</p>
132+
</li>
133+
<li>
134+
<p>Before you start writing any code, play around with the API through the
135+
commandline with <a href="http://curl.haxx.se/">curl</a> or in the browser with
136+
<a href="http://www.getpostman.com/">Postman</a>. This exercise will help you get
137+
a better understanding of API authentication and the data required for
138+
requests and responses.</p>
139+
</li>
140+
<li>
141+
<p>Evaluate whether to use a helper library or work with
142+
<a href="http://docs.python-requests.org/en/latest/">Requests</a>. Helper libraries
143+
are usually easier to get started with while Requests gives you more
144+
control over the HTTP calls.</p>
145+
</li>
146+
<li>
147+
<p>Move your API calls into a <a href="/task-queues.html">task queue</a> so they do not
148+
block the HTTP request-response cycle for your web application.</p>
149+
</li>
150+
</ol>
151+
<h3>What's next after integrating web APIs into your project?</h3>
145152
<div class="row">
146153
<div class="col-md-4">
147154
<div class="well select-next">

‎application-programming-interfaces.html‎

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -97,18 +97,26 @@ <h2>API resources</h2>
9797
</li>
9898
</ul>
9999
<h2>APIs learning checklist</h2>
100-
<p><i class="fa fa-check-square-o"></i>
101-
Learn the API concepts of machine-to-machine communication with JSON and XML,
102-
endpoints and webhooks.</p>
103-
<p><i class="fa fa-check-square-o"></i>
104-
Integrate an API such as Twilio or Stripe into your web application. Read the
105-
<a href="/api-integration.html">API integration</a> section for more information.</p>
106-
<p><i class="fa fa-check-square-o"></i>
107-
Use a framework to create an API for your own application. </p>
108-
<p><i class="fa fa-check-square-o"></i>
109-
Expose your web application's API so other applications can consume data you
110-
want to share.</p>
111-
<h3>What's next after learning about APIs?</h3>
100+
<ol>
101+
<li>
102+
<p>Learn the API concepts of machine-to-machine communication with JSON and
103+
XML, endpoints and webhooks.</p>
104+
</li>
105+
<li>
106+
<p>Integrate an API such as Twilio or Stripe into your web application.
107+
Read the <a href="/api-integration.html">API integration</a> section for more
108+
information.</p>
109+
</li>
110+
<li>
111+
<p>Use a framework to create an API for your own application. Learn about
112+
web API frameworks on the <a href="/api-creation.html">API creation</a> page.</p>
113+
</li>
114+
<li>
115+
<p>Expose your web application's API so other applications can consume data
116+
you want to share.</p>
117+
</li>
118+
</ol>
119+
<h3>Do you want to know more about integrating or creating APIs?</h3>
112120
<div class="row">
113121
<div class="col-md-4">
114122
<div class="well select-next">

‎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>2015-05-29T11:04:35Z</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>2015-05-29T11:21:04Z</updated></feed>

‎source/content/pages/06-web-apis/01-application-programming-interfaces.markdown‎

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -70,20 +70,16 @@ on the number's page on Twilio as shown below.
7070

7171

7272
## APIs learning checklist
73-
<i class="fa fa-check-square-o"></i>
74-
Learn the API concepts of machine-to-machine communication with JSON and XML,
75-
endpoints and webhooks.
73+
1. Learn the API concepts of machine-to-machine communication with JSON and
74+
XML, endpoints and webhooks.
7675

77-
<i class="fa fa-check-square-o"></i>
78-
Integrate an API such as Twilio or Stripe into your web application. Read the
79-
[API integration](/api-integration.html) section for more information.
76+
1. Integrate an API such as Twilio or Stripe into your web application.
77+
Read the [API integration](/api-integration.html) section for more
78+
information.
8079

81-
<i class="fa fa-check-square-o"></i>
82-
Use a framework to create an API for your own application.
80+
1. Use a framework to create an API for your own application. Learn about
81+
web API frameworks on the [API creation](/api-creation.html) page.
8382

84-
<i class="fa fa-check-square-o"></i>
85-
Expose your web application's API so other applications can consume data you
86-
want to share.
83+
1. Expose your web application's API so other applications can consume data
84+
you want to share.
8785

88-
89-
### What's next after learning about APIs?

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

Lines changed: 15 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -79,30 +79,23 @@ across many implementation areas.
7979

8080

8181
## API integration learning checklist
82-
<i class="fa fa-check-square-o"></i>
83-
Pick an API known for top notch documentation. Here's a list of
84-
[ten APIs that are a good starting point for beginners](https://medium.com/she-hacks-hacker-academy/4d3c43be9386).
82+
1. Pick an API known for top notch documentation. Here's a list of
83+
[ten APIs that are a good starting point for beginners](https://medium.com/she-hacks-hacker-academy/4d3c43be9386).
8584

86-
<i class="fa fa-check-square-o"></i>
87-
Read the API documentation for your chosen API. Figure out a simple use case
88-
for how your application could be improved by using that API.
85+
1. Read the API documentation for your chosen API. Figure out a simple
86+
use case for how your application could be improved by using that API.
8987

90-
<i class="fa fa-check-square-o"></i>
91-
Before you start writing any code, play around with the API through the
92-
commandline with [curl](http://curl.haxx.se/) or in the browser with
93-
[Postman](http://www.getpostman.com/). This exercise will help you get a
94-
better understanding of API authentication and the data required for requests
95-
and responses.
88+
1. Before you start writing any code, play around with the API through the
89+
commandline with [curl](http://curl.haxx.se/) or in the browser with
90+
[Postman](http://www.getpostman.com/). This exercise will help you get
91+
a better understanding of API authentication and the data required for
92+
requests and responses.
9693

97-
<i class="fa fa-check-square-o"></i>
98-
Evaluate whether to use a helper library or work with
99-
[Requests](http://docs.python-requests.org/en/latest/). Helper libraries are
100-
usually easier to get started with while Requests gives you more control over
101-
the HTTP calls.
94+
1. Evaluate whether to use a helper library or work with
95+
[Requests](http://docs.python-requests.org/en/latest/). Helper libraries
96+
are usually easier to get started with while Requests gives you more
97+
control over the HTTP calls.
10298

103-
<i class="fa fa-check-square-o"></i>
104-
Move your API calls into a [task queue](/task-queues.html) so they do not
105-
block the HTTP request-response cycle for your web application.
99+
1. Move your API calls into a [task queue](/task-queues.html) so they do not
100+
block the HTTP request-response cycle for your web application.
106101

107-
108-
### What's next after integrating APIs into your app?

0 commit comments

Comments
 (0)