book

Python API Development Fundamentals

Name: Python API Development Fundamentals
ISBN: 9781838983994

by Jack Chan, Ray Chung, Jack Huang

November 2019

Beginner to intermediate

372 pages

6h 24m

English

Packt Publishing

Read now

Unlock full access

Preface
About the BookAbout the AuthorsLearning ObjectivesAudienceApproachHardware RequirementsSoftware RequirementsConventionsInstallation and SetupAdditional Resources
1. Your First Step
IntroductionUnderstanding APIRESTful APIREST Constraints/PrinciplesHTTP ProtocolHTTP Methods and CRUDThe JSON FormatHTTP Status CodesCommonly used HTTP Status CodesOpen APIThe Flask Web FrameworkBuilding a Simple Recipe Management ApplicationVirtual EnvironmentExercise 1: Building Our First Flask ApplicationExercise 2: Managing Recipes with FlaskUsing curl or httpie to Test All the EndpointsExercise 3: Testing Our API Endpoints with httpie and curlPostmanThe Postman GUISending a GET RequestSending a POST RequestSaving a RequestActivity 1: Sending Requests to Our APIs Using PostmanExercise 4: Automated Testing Using PostmanActivity 2: Implement and Test the delete_recipe FunctionSummary
2. Starting to Build Our Project
IntroductionWhat is Flask-RESTful?Using Flask-RESTful to Develop Our Recipe-Sharing Platform, "Smilecook"Virtual EnvironmentExercise 5: Creating a Development Project in PyCharmCreating a Recipe ModelExercise 6: Creating the Recipe ModelResourceful RoutingExercise 7: Defining an API Endpoint for the Recipe ModelExercise 8: Defining the Recipe ResourceExercise 9: Publishing and Unpublishing the RecipesConfiguring EndpointsExercise 10: Creating the Main Application FileMaking HTTP Requests to the Flask API using curl and httpieExercise 11: Testing the Endpoints Using curl and httpieExercise 12: Testing the Auto-Incremented Recipe IDExercise 13: Getting All the Recipes BackExercise 14: Testing the Recipe ResourcesExercise 15: Negative TestingExercise 16: Modifying the RecipesExercise 17: Getting Back Specific Recipes with a Certain IDActivity 3: Testing the APIs Using PostmanActivity 4: Implementing the Delete Recipe FunctionSummary
3. Manipulating a Database with SQLAlchemy
IntroductionDatabasesDatabase Management SystemSQLORMExercise 18: Setting Up a Smilecook DatabaseDefining Our ModelsExercise 19: Installing Packages and Defining Models Exercise 20: Using Flask-Migrate to Build a Database Upgrade ScriptExercise 21: Applying Database InsertionActivity 5: Creating a User and a RecipePassword HashingExercise 22: Implement the User Registration Feature and Hash the User's PasswordExercise 23: Testing the Application in PostmanActivity 6: Upgrading and Downgrading a DatabaseSummary
4. Authentication Services and Security with JWT
IntroductionJWTFlask-JWT-ExtendedExercise 24: Implementing a User Login FunctionExercise 25: Testing the User Login FunctionExercise 26: Creating the me EndpointDesigning the Methods in the Recipe ModelExercise 27: Implementing Access-Controlled Recipe Management FunctionsExercise 28: Testing the Recipe Management FunctionsRefresh TokensExercise 29: Adding a Refresh Token FunctionExercise 30: Obtaining a New Access Token Using a Refresh TokenThe User Logout MechanismExercise 31: Implementing the Logout FunctionExercise 32: Testing the Logout FunctionActivity 7: Implementing Access Control on the publish/unpublish Recipe FunctionSummary
5. Object Serialization with marshmallow
IntroductionSerialization versus DeserializationmarshmallowA Simple SchemaField ValidationCustomizing Deserialization MethodsUserSchema DesignExercise 33: Using marshmallow to Validate the User DataExercise 34: Testing the User Endpoint before and after AuthenticationRecipeSchema DesignExercise 35: Implementing RecipeSchemaExercise 36: Testing the Recipe APIThe PATCH MethodExercise 37: Using the PATCH Method to Update the RecipeSearching for Authors and Unpublished RecipesUsing the webargs Package to Parse the Request ArgumentsExercise 38: Implementing Access Control on RecipesExercise 39: Retrieving Recipes from a Specific AuthorActivity 8: Serializing the recipe Object Using marshmallowSummary
6. Email Confirmation
IntroductionMailgunExercise 40: Get Started with Using MailgunExercise 41: Using the Mailgun API to Send Out EmailsUser Account Activation WorkflowExercise 42: Generating the Account Activation TokenExercise 43: Sending Out the User Account Activation EmailActivity 9: Testing the Complete User Registration and Activation WorkflowSetting Up Environment VariablesExercise 44: Setting Up Environment Variables in PyCharmHTML Format EmailActivity 10: Creating the HTML Format User Account Activation EmailSummary
7. Working with Images
IntroductionBuilding the User Avatar FunctionExercise 45: Adding the avatar_image Attribute to the User ModelFlask-UploadsUpload SetsExercise 46: Implementing the User Avatar Upload FunctionExercise 47: Testing the User Avatar Upload Function Using PostmanImage Resizing and CompressionIntroduction to PillowExercise 48: Implementing Image Compression in Our Smilecook ApplicationExercise 49: Testing the Image Compression FunctionActivity 11: Implementing the Recipe Cover Image Upload FunctionActivity 12: Testing the Image Upload FunctionSummary
8. Pagination, Searching, and Ordering
IntroductionPaginationPaginated APIsExercise 50: Implementing Pagination on the Published Recipes Retrieval FunctionExercise 51: Testing the Pagination FunctionsActivity 13: Implementing Pagination on the User-Specific Recipe Retrieval APIActivity 14: Testing Pagination on the User-Specific Recipe Retrieval APIRecipe SearchingExercise 52: Implementing the Search FunctionExercise 53: Testing the Search FunctionSorting and OrderingExercise 54: Implementing Sorting and OrderingExercise 55: Testing the Sorting and Ordering FeatureActivity 15: Searching for Recipes with Specific IngredientsSummary
9. Building More Features
IntroductionCachingBenefit of CachingFlask-CachingExercise 56: Implementing Caching Functionality Using Flask-CachingExercise 57: Testing the Caching Function with PostmanClearing the Cache when Data UpdatesActivity 16: Getting Cache Data after Updating Recipe DetailsExercise 58: Implementing Cache-Clearing FunctionalityExercise 59: Verifying the Cache-Clearing FunctionAPI Rate LimitingHTTP Headers and Response CodesFlask-LimiterExercise 60: Implementing API Rate-Limiting FunctionalityExercise 61: Verifying the Rate-Limit FunctionExercise 62: Adding a WhitelistActivity 17: Adding Multiple Rate-Limit RestrictionsSummary

10. Deployment
IntroductionDeploymentComparing SaaS, PaaS, and IaaSThe Heroku PlatformConfiguration Handling in SmilecookExercise 63: Configuration Handling for the Production and Development EnvironmentsExercise 64: Adding a Staging Configuration ClassHeroku ApplicationExercise 65: Creating a New Application in HerokuHeroku Add-OnsExercise 66: Installing Heroku PostgresSetting Up Environment Variables for the Heroku AppExercise 67: Setting Up the App Environment VariablesDeployment Using Heroku GitWhat is Git?What is gitignore?What is Procfile?What is Gunicorn?Exercise 68: Setting Up the Git and the Heroku CLIExercise 69: Checking the Heroku Postgres Tables in pgAdminSetting Up Variables in PostmanExercise 70: Setting Up Variables in PostmanActivity 18: Changing access_token to a Variable in PostmanSetting up the Front-end Interface to Work with the Smilecook APISummary
Appendix
1: Your First StepActivity 1: Sending Requests to Our APIs Using PostmanActivity 2: Implement and Test the delete_recipe Function2: Starting to Build Our ProjectActivity 3: Testing the APIs Using PostmanActivity 4: Implementing the Delete Recipe Function3: Manipulating a Database with SQLAlchemyActivity 5: Creating a User and a RecipeActivity 6: Upgrading and Downgrading a Database4: Authenticated Services and Security with JWTsActivity 7: Implementing Access Control on the publish/unpublish Recipe Function5: Validating APIs Using marshmallowActivity 8: Serializing the recipe Object Using marshmallow6: Email ConfirmationsActivity 9: Testing the Complete User Registration and Activation WorkflowActivity 10: Creating the HTML Format User Account Activation Email7: Working with ImagesActivity 11: Implementing the Recipe Cover Image Upload FunctionActivity 12: Testing the Image Upload Function8: Pagination, Searching, and OrderingActivity 13: Implementing Pagination on the User-Specific Recipe Retrieval APIActivity 14: Testing Pagination on the User-Specific Recipe Retrieval APIActivity 15: Searching for Recipes with Specific Ingredients9: Building More FeaturesActivity 16: Getting Cache Data after Updating Recipe DetailsActivity 17: Adding Multiple Rate-Limit Restrictions10: DeploymentActivity 18: Changing access_token to a Variable in Postman

Content preview from Python API Development Fundamentals

2. Starting to Build Our Project

Learning Objectives

By the end of this chapter, you will be able to:

Build a Restful API service efficiently using the Flask-Restful package
Build an extendable Flask project
Perform CRUD operations using the model
Test RESTful APIs using curl, httpie, and Postman

In this chapter, we will start to work on the food recipe-sharing platform and learn how to create a RESTful API application.

Introduction

Now that we've introduced APIs and learned a bit about HTTP and REST, we will work on building an application (the recipe-sharing app known as Smilecook). In this chapter, we aim to kick-start the actual project development. This is a recipe-sharing platform in which users can create accounts and share ...

Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.

Read now

Unlock full access

More than 5,000 organizations count on O’Reilly

O’Reilly covers everything we've got, with content to help us build a world-class technology community, upgrade the capabilities and competencies of our teams, and improve overall team performance as well as their engagement.

Julian F.

Head of Cybersecurity

I wanted to learn C and C++, but it didn't click for me until I picked up an O'Reilly book. When I went on the O’Reilly platform, I was astonished to find all the books there, plus live events and sandboxes so you could play around with the technology.

Addison B.

Field Engineer

I’ve been on the O’Reilly platform for more than eight years. I use a couple of learning platforms, but I'm on O'Reilly more than anybody else. When you're there, you start learning. I'm never disappointed.

Amir M.

Data Platform Tech Lead

I'm always learning. So when I got on to O'Reilly, I was like a kid in a candy store. There are playlists. There are answers. There's on-demand training. It's worth its weight in gold, in terms of what it allows me to do.

Mark W.

Embedded Software Engineer

Build REST APIs with Django REST Framework and Python

Publisher Resources

ISBN: 9781838983994

Cloud Computing

Data Engineering

Data Science

AI & ML

Programming Languages

Software Architecture

IT/Ops

Security

Design