<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

<meta charset="utf-8">

<meta http-equiv="X-UA-Compatible" content="IE=edge">

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<meta name="author" content="Matt Makai">

<link rel="shortcut icon" href="theme/img/fsp-fav.png">

<title>API Creation - Full Stack Python</title>

<!--[if lt IE 9]>

<style>

.toc-indent {padding-left: 25px;}

.toc-more-indent {padding-left: 37px;}

</style>

<script>

(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){

(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),

m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)

})(window,document,'script','//www.google-analytics.com/analytics.js','ga');

ga('create', 'UA-19910497-7', 'auto');

ga('send', 'pageview');

</script> </head>

<a href="https://github.com/makaimc/fullstackpython.github.com"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://camo.githubusercontent.com/a6677b08c955af8400f44c6298f40e7d19cc5b2d/68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f6769746875622f726962626f6e732f666f726b6d655f72696768745f677261795f3664366436642e706e67" alt="Fork me on GitHub" data-canonical-src="https://s3.amazonaws.com/github/ribbons/forkme_right_gray_6d6d6d.png"></a>

<div class="container">

<div class="row">

<div class="col-md-12">

<div class="logo-header-section">

<a href="/" style="text-decoration: none; border: none;"><img src="theme/img/fsp-logo.png" height="52" width="52" class="logo-image" style="padding-top: 1px;" alt="Full Stack Python logo"></a>

<span class="logo-title"><a href="/">Full Stack Python</a></span>

</div>

</div>

</div><div class="row">

<div class="col-md-8">

<h1>API Creation</h1>

<p>Creating and exposing APIs allows your web application to interact with other

applications through machine-to-machine communication.</p>

<h2>API creation frameworks</h2>

<p><a href="http://www.django-rest-framework.org/">Django REST framework</a> and

<a href="https://django-tastypie.readthedocs.org/en/latest/">Tastypie</a> are

the two most widely used API frameworks to use with Django. The edge

currently goes to Django REST framework based on rough community sentiment.

Django REST framework recently hit the

<a href="http://www.django-rest-framework.org/topics/3.0-announcement/">3.0 release mark</a>

after Tom Christie ran a

<a href="https://www.kickstarter.com/projects/tomchristie/django-rest-framework-3">successful Kickstarter campaign</a>.</p>

<p><a href="http://flask-restful.readthedocs.org/en/latest/">Flask-RESTful</a> and

<a href="http://flask.pocoo.org/docs/api/">Flask API</a> are popular libraries for

exposing APIs from Flask web applications.</p>

<p><a href="http://www.github.com/jeffknupp/sandman">Sandman</a> is a widely used tool to

automatically generate a RESTful API service from a legacy database without

writing a line of code (though it's easily extensible through code).</p>

<p><a href="https://cornice.readthedocs.org/en/latest/">Cornice</a> is a REST framework

for Pyramid.</p>

<p><a href="https://github.com/toastdriven/restless">Restless</a> is a lightweight API

framework that aims to be framework agnostic. The general concept is that

you can use the same API code for Django, Flask, Bottle, Pyramid or any

other WSGI framework with minimal porting effort.</p>

<p><a href="http://python-eve.org/">Eve</a> is a Python REST framework built with Flask,

MongoDB and Redis. The framework's primary author

<a href="https://twitter.com/nicolaiarocci">Nicola Iarocci</a> gave a great talk at

<a href="https://www.youtube.com/watch?v=9sUsLvG72_o">EuroPython 2014</a> that

introduced the main features of the framework.</p>

<h2>API testing projects</h2>

<p>Building, running and maintaining APIs requires as much effort as building,

running and maintaining a web application. API testing frameworks are the

equivalent of browser testing in the web application world.</p>

<li><a href="https://github.com/zatosource/zato-apitest">zato-apitest</a> invokes HTTP

APIs and provides hooks for running through other testing frameworks.</li>

<h2>Hosted API testing services</h2>

<p><a href="https://www.runscope.com/">Runscope</a> is an API testing SaaS application

that can test both your own APIs and external APIs that your application

relies upon.</p>

<p><a href="https://www.apiscience.com/">API Science</a> is focused on deep API testing,

including multi-step API calls and monitoring of external APIs.</p>

<p><a href="http://smartbear.com/api-testing/">SmartBear</a> has several API monitoring

and testing tools for APIs.</p>

<h2>API creation resources</h2>

<p><a href="http://pydanny.com/choosing-an-api-framework-for-django.html">Choosing an API framework for Django</a>

by <a href="https://twitter.com/pydanny">PyDanny</a> contains questions and insight

into what makes a good API framework and which one you should currently

choose for Django.</p>

<p><a href="http://www.slideshare.net/Solution4Future/python-restful-webservices-with-python-flask-and-django-solutions">RESTful web services with Python</a>

is an interesting overview of the Python API frameworks space.</p>

<p><a href="http://www.slideshare.net/jmusser/ten-reasons-developershateyourapi">10 Reasons Why Developers Hate Your API (And what to do about it)</a>

goes through the top difficulties and annoyances developers face when

working with APIs and how you can avoid your API falling into the same

traps.</p>

<p>Versioning of RESTful APIs is a difficult and contentious topic in the

web API community. This two-part series covers

<a href="http://urthen.github.io/2013/05/09/ways-to-version-your-api/">various ways to version your API</a>

and <a href="http://urthen.github.io/2013/05/16/ways-to-version-your-api-part-2/">how to architect a version-less API</a>.</p>

<p><a href="http://www.narwhl.com/">NARWHL</a> is a practical API design site for

developers confused about what is appropriate for RESTful APIs.</p>

<p><a href="http://blog.luisrei.com/articles/flaskrest.html">Implementing a RESTful Web API with Python &amp; Flask</a>

is a straightforward introduction to using Flask to create request

handling and responses to produce a web API.</p>

<p>This <a href="https://github.com/interagent/http-api-design">API Design Guide</a>

is based on Heroku's best practices for the platform's API.</p>

<p><a href="https://18f.gsa.gov/">18F</a>'s

<a href="https://github.com/18f/api-standards">API standards</a> explains the details

behind their design decisions on creating modern RESTful APIs.</p>

<p><a href="https://medium.com/@zwacky/design-a-beautiful-rest-api-901c73489458">Design a beautiful REST API</a>

reviews common design decisions regarding endpoints, versioning, errors and

pagination. There is also a

<a href="https://www.youtube.com/watch?v=5WXYw4J4QOU">source material YouTube video</a>

where this blog post derives its recommendations from.</p>

<p><a href="http://amberonrails.com/move-fast-dont-break-your-api/">Move Fast, Don't Break Your API</a>

are slides and a detailed blog post from Amber Feng at Stripe about

building an API, separating layers of responsibility, hiding backwards

compatibility and a whole slew of other great advice for developers

and API designers.</p>

<p><a href="http://www.bizcoder.com/self-descriptive-isn-t-don-t-assume-anything">Self-descriptive, isn't. Don't assume anything.</a>

is an appeal that metadata makes a difference in whether APIs are descriptive

or not.</p>

<p><a href="http://artsy.github.io/blog/2014/09/12/designing-the-public-artsy-api/">Designing the Artsy API</a>

has their recommendations list for building an API based on their recent

experiences.</p>

<p><a href="https://bourgeois.me/rest/">Some REST Best Practices</a> is a high level

summary of rules to follow while creating your API.</p>

<p>Hacker News had a discussion on

<a href="https://news.ycombinator.com/item?id=8912897">what's the best way to write an API spec?</a>

that provides a few different viewpoints on this topic.</p>

<p><a href="https://pages.apigee.com/rs/apigee/images/api-design-ebook-2012-03.pdf">Apigee's Web API Design ebook</a>

is free and contains a wealth of practical advice for what design

decisions to make for your web API.</p>

<h2>API creation learning checklist</h2>

<p><i class="fa fa-check-square-o"></i>

Pick an API framework appropriate for your web framework. For Django I

recommend Django REST framework and for Flask I recommend Flask-RESTful.</p>

<p><i class="fa fa-check-square-o"></i>

Begin by building out a simple use case for the API. Generally the use case

will either involve data that users want in a machine-readable format or a

backend for alternative clients such as an iOS or Android mobile app.</p>

<p><i class="fa fa-check-square-o"></i>

Add an authentication mechanism through OAuth or a token scheme.</p>

<p><i class="fa fa-check-square-o"></i>

Add rate limiting to the API if data usage volume could be a performance issue.

Also add basic metrics so you can determine how often the API is being

accessed and whether it is performing properly.</p>

<p><i class="fa fa-check-square-o"></i>

Provide ample documentation and a walkthrough for how the API can be accessed

and used.</p>

<p><i class="fa fa-check-square-o"></i>

Figure out other use cases and expand based on what you learned with the

initial API use case.</p>

<h3>What's next after building an API for your web app?</h3>

<div class="row">

<div class="col-md-3">

<div class="well select-next">

<a href="/application-programming-interfaces.html" class="btn btn-success btn-full"><i class="fa fa-exchange fa-2x"></i></a>

<p class="under-btn">

What are application programming interfaces?

</p>

</div>

</div>

<div class="col-md-3">

<div class="well select-next">

<a href="/api-integration.html" class="btn btn-success btn-full"><i class="fa fa-link fa-2x"></i></a>

</a>

<p class="under-btn">

How do I integrate external APIs into my application?

</p>

</div>

</div>

<div class="col-md-3">

<div class="well select-next">

<a href="/web-application-security.html" class="btn btn-success btn-full"><i class="fa fa-lock fa-inverse fa-2x"></i></a>

<p class="under-btn">

How can I learn about web application security?

</p>

</div>

</div>

<div class="col-md-3">

<div class="well select-next">

<a href="/static-content.html" class="btn btn-success btn-full"><i class="fa fa-spinner fa-inverse fa-2x"></i></a>

<p class="under-btn">

Where should I host static content such as JavaScript files?

</p>

</div>

</div>

</div> <div id="mc_embed_signup">

<form action="//mattmakai.us2.list-manage.com/subscribe/post?u=b7e774f0c4f05dcebbfee183d&amp;id=b22335388d" method="post" id="mc-embedded-subscribe-form" name="mc-embedded-subscribe-form" class="validate" target="_blank" novalidate>

<div id="mc_embed_signup_scroll">

<h4>Interested in major updates to this site or an alert when a complete Full Stack Python book with detailed example code is released? Sign up here and you'll an occasional email only when there's big news to report.</h4>

<div class="row">

<div class="col-md-9">

<input type="email" value="" name="EMAIL" class="email form-control" id="mce-EMAIL" placeholder="email address" required>

<div style="position: absolute; left: -5000px;"><input type="text" name="b_b7e774f0c4f05dcebbfee183d_b22335388d" tabindex="-1" value=""></div>

</div>

<div class="col-md-3">

<div class="clear"><input type="submit" value="Subscribe" name="subscribe" id="mc-embedded-subscribe" class="btn btn-success" style="font-family: 'Helvetica Neue';"></div>

</div>

</div>

</div>

</div>

<div class="col-md-offset-1 col-md-3" id="sidebar">

<div class="panel panel-success">

<div class="panel-heading">

<h3 class="panel-head"><a href="/table-of-contents.html" style="color: #fff;">Table of Contents</a></h3>

</div>

<div class="list-group">

<a href="/introduction.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Introduction</a>

<a href="/why-use-python.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Why Use Python?</a>

<a href="/development-environments.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Development Environments</a>

<a href="/vim.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Vim</a>

<a href="/best-python-resources.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Best Python Resources</a>

<a href="/generators.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Generators</a>

<a href="/web-frameworks.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Web Frameworks</a>

<a href="/django.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Django</a>

<a href="/flask.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Flask</a>

<a href="/bottle.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Bottle</a>

<a href="/pyramid.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Pyramid</a>

<a href="/morepath.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Morepath</a>

<a href="/other-web-frameworks.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Other Web Frameworks</a>

<a href="/web-design.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Web Design</a>

<a href="/cascading-style-sheets.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Cascading Style Sheets</a>

<a href="/javascript.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>JavaScript</a>

<a href="/websockets.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>WebSockets</a>

<a href="/web-application-security.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Web Application Security</a>

<a href="/databases.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Databases</a>

<a href="/no-sql-datastore.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>NoSQL Data Stores</a>

<a href="/application-programming-interfaces.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Application Programming Interfaces</a>

<a href="/api-integration.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>API Integration</a>

<a href="/api-creation.html" class="list-group-item smaller-item active" style='font-family: "Helvetica Neue",sans-serif;'>API Creation</a>

<a href="/deployment.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Deployment</a>

<a href="/servers.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Servers</a>

<a href="/platform-as-a-service.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Platform-as-a-service</a>

<a href="/operating-systems.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Operating Systems</a>

<a href="/web-servers.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Web Servers</a>

<a href="/wsgi-servers.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>WSGI Servers</a>

<a href="/source-control.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Source Control</a>

<a href="/application-dependencies.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Application Dependencies</a>

<a href="/static-content.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Static Content</a>

<a href="/task-queues.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Task Queues</a>

<a href="/configuration-management.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Configuration Management</a>

<a href="/continuous-integration.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Continuous Integration</a>

<a href="/logging.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Logging</a>

<a href="/monitoring.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Monitoring</a>

<a href="/web-analytics.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Web Analytics</a>

<a href="/docker.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Docker</a>

<a href="/caching.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Caching</a>

<a href="/code-metrics.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Code Metrics</a>

<a href="/what-full-stack-means.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>What "Full Stack" Means</a>

<a href="/change-log.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Change Log</a>

<a href="/future-directions.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>Future Directions</a>

<a href="/about-author.html" class="list-group-item smaller-item " style='font-family: "Helvetica Neue",sans-serif;'>About the Author</a>

</div>

</div>

<div class="panel panel-success">

<div class="panel-heading"><h3 class="panel-head">API Creation</h3></div>

<div class="panel-body">

Need more detailed tutorials and walkthroughs than you see here?

<a href="/email.html">Sign up for an email alert when that content is created.</a>

<hr/>

<a href="/">Full Stack Python</a> is an open book that explains

concepts in plain language and provides the most helpful resources

on those topics.

<hr/>

<a href="http://twitter.com/mattmakai">Matt Makai</a> built

this site with appreciated assistance from

<a href="https://github.com/makaimc/fullstackpython.github.com/pulls">pull requests</a>.

Major updates are tweeted via the

<a href="https://twitter.com/fullstackpython">@fullstackpython</a>

account.

</div>

</div>

<hr/>

<div class="footer pull-right">

<a href="http://www.mattmakai.com/" class="underline">Matt Makai</a>

2015

</div>

</div>

<link href="theme/css/f.min.css" rel="stylesheet">

<link href="//netdna.bootstrapcdn.com/font-awesome/4.1.0/css/font-awesome.css" rel="stylesheet">