Professional RESTful API Design using Python Flask

Name: Professional RESTful API Design using Python Flask
Rating: 4.2 (169 reviews)

Learn the fundamental concepts and build a RESTful API application from scratch

Created byJorge Escobar

Last updated 12/2017

English

What you'll learn

You will learn the fundamental concepts for the design of RESTful API platforms
You will be introduced to the RESTful API constraints
You will learn how to setup an authentication API layer
You will learn how to effectively build API endpoints

Course content

4 sections • 37 lectures • 4h 36m total length

Introduction1:09
Introduction
- What do we want to accomplish in this course?
- Prerequisites
- What do I need to have to complete this course?
APIs and the Six Constraints of REST10:39
What is an API?
API stands for "Application programming interface", and it's a set of routines, protocols and tools for building interactions between clients and servers.
What is REST?

REST stands for “Representational State Transfer” and it's a networked, hypermedia architectural style typified by the web

REST by design has six constraints:

Uniform interface

Stateless

Cacheable

Client-server

Layered System

Code on Demand (optional)
The RESTful Uniform Interface Constraint13:21
Uniform Interface

Resource-Based

Manipulation of Resources Through Representations

Self-descriptive Messages

Hypermedia as the Engine of Application State (HATEOAS)

Installing the Docker Client2:24
Installing the Docker Client
Basic Container Structure7:30
Running the Container4:50
- Docker client for Mac
- Docker compose
- Running the containers separately for pdb
Flask Pluggable Views and Our First GET Method12:22
- Using Flask pluggable views
- Explain Flask pluggable views - http://flask.pocoo.org/docs/0.11/views/
- Our first endpoint, /pets
- A simple GET pluggable view
Using Postman7:03
Using Postman - https://www.getpostman.com/
Our First POST9:10
A simple POST handler
An Introduction to HTTP Status Codes8:53
Talk about HTTP Status Codes - http://www.restapitutorial.com/httpstatuscodes.html
A Real CRUD9:21
- Build a GET individual pet endpoint
- Add location to all pets (HATEOAS)
PUT and DELETE12:03
Implement PUT, DELETE on pets
A Simple Authentication6:55
Explanation of the authentication design we are going to use
Testing our Simple Authentication7:16
- Write a decorator to allow the user to access the API
- Add authentication to headers in Postman
Token API Model and API Endpoints14:22
Create the app registration endpoint and generator
Token API Views and Decorator6:07
Build the token-based application access decorator
Install bcrypt and Test Tokens14:00
Building the Apps Tests7:42
Start a testing framework
Token Tests4:48
Token Tests
Starting the Store End Point3:24
- Build store models
- Don't expose MongoDB ID, use uuid
The JSON Schema Library8:42
- Validation of data using jsonschema - http://python-jsonschema.readthedocs.io/en/latest/
- Great resource - https://spacetelescope.github.io/understanding-json-schema/index.html - to understanding it
The Store API File6:34
Build JSON templates
Trying out the Stores End Point8:17
Use Postman to test the Store end points
Implementing PUT and DELETE10:38
- PUT operations are the update of CRUD. It generally receives all the fields with the ones being updated changed.
- PATCH is used for updating only specific fields (we won't implement)
- Implement DELETE
Implementing pagination on GET all stores7:52
- Pagination
- Results should always be paginate
- Links within show next and prev
- This is the HATEOAS of the app
Store Tests11:42
- Testing CRUD
- Testing pagination
- Introduction to Fixtures
- Custom fixtures using mongoimport
Pet Endpoint Initial CRUD9:34
- Create CRUD
Finishing Pet GET, POST and Postman Tests10:15
- Postman Tests
Pets PUT and DELETE4:52
- PUT and DELETE for Pets endpoint
Pets Tests7:45
- Write tests for Pets endpoint
Pets Pagination Tests3:13
- Pets pagination tests
Get all Pets in a Specific Store Endpoint8:52
- Use the same Store GET endpoint
Testing the get all pets endpoint5:27
Get all pets in a specific store using Postman
Search pets across stores7:22
Search pets across stores
Implementing filters across stores
Create a pets_href template to add filters

Requirements

A computer with internet access and administrative access to install packages
Good understanding of how to use the command line interface, internet and code editors
Good knowledge of the Flask web framework

Description

This course will teach you how to build a professional API platform using pure Flask, without any supplemental libraries, so that students can learn the fundamentals of RESTful API design.

In today’s world, dominated by gorgeous JavaScript user interfaces and mobile applications, the ability to build a scalable and well architected API is key to be able to supplement those applications and ensure that clients and servers communicate with the proper interfaces.

The course covers the basic concepts of the RESTful API pattern and then goes into detail and step by step building an API platform that will cover the six constraints of the architecture. Students will learn the industry-standard and will follow best practices for API architectures.

At the end of the course students will be able to design, architect and build their own RESTful API platforms, and with the deep understanding of the laws governing APIs, can go ahead and try out the API libraries available for Python and Flask, knowing the fundamentals and the advantages of using them.

If you already know the basics of Flask and you are interested in how to design, architect and build an API platform, this is the course for you.

The course is divided in 2 sections:

Introduction which covers all the concepts necessary to understand what is a RESTful API and its six constraints
A step by step explanation building a Pet Store API that will include an authentication layer, a Store endpoint and a Pet endpoint as well as search functionalities

The course has more than 5 hours of video tutorials as well as the source code at the end of each section, so that you can follow along with the coding process.

The course can take anywhere from 3 to 10 days to complete based on how much material the student completes daily.

Additionally we’re constantly updating the course, adding contents thanks to the feedback of our students.

Join this course and continue your path to becoming a professional backend web developer!

Who this course is for:

Programmers and developers with basic Flask knowledge who want to learn how to design and build professional API platforms
Application architects who want to understand better how to build API applications
Startup CTOs who want to understand better best practices for API design
Computer Science Students who want to get exposed to real life API building concepts

Professional RESTful API Design using Python Flask

What you'll learn

Explore related topics

Course content

Introduction3 lectures • 25min

A Simple API - Pet Store31 lectures • 4hr 9min

Conclusion2 lectures • 2min

Bonus Section1 lecture • 1min

Requirements

Description

Who this course is for: