[TalkPython] RESTful и HTTP API в Pyramid

RESTful и HTTP API в Pyramid


Краткое описание курса
Если вы добавляете API в существующее веб-приложение, создаете новый API для тяжелого клиентского приложения JavaScript или даже создаете бэкэнд-сервис для мобильного приложения, этот курс покажет вам, как создавать службы RESTful с помощью Pyramid и Интегрироваться с реальной базой данных по SQLAlchemy.

Для кого этот курс?
Любой, кто знает Python и хотел бы использовать Python для создания гибких и высокопроизводительных веб-сервисов RESTful или HTTP.

Если вам нужен бэкенд для вашего мобильного приложения, богатое приложение для JavaScript или хотите добавить API к существующему веб-приложению Pyramid, этот курс научит вас концепциям, а также методам программирования для их реализации.

Что вы узнаете на этом курсе?
К числу затронутых тем относятся.

• Настройка Python 3, Postman и PyCharm для локального развития
• Концепции и принципы сервисов RESTful
• Ключевые строительные блоки в веб-фреймворке Pyramid
• Создание комплексного сервиса с использованием HTTP-заголовков, кодов состояния, типов контента и т. Д.
• Добавление согласования контента в службы
• Принудительная идентификация и авторизация с использованием ключей API
• Как вызвать службу из Python и из JavaScript
• Добавить поддержку CORS для межсайтового доступа
• Основы SQLAlchemy для поддержки наших служб с помощью базы данных
• Как добавить журнал и контроль времени выполнения ошибок
• Развертывание вашей службы на Linux за NGINX и uWSGI для развертывания с полным производством

Спойлер: Содержание

Welcome to the course

The power of APIs​

Course setup and tools

Course requirements and tools
Setup on macOS
Setup on Windows
Setup on Linux (Ubuntu)​

What is REST?

Introduction to RESTful services
HTTP verbs
HTTP status codes
Example service: GitHub
Example service: Basecamp
Comparing REST/HTTP services to other service types​

Web application building blocks

Python web frameworks
Pyramid building blocks
Pyramid building block: Views
Pyramid building block: Routes
Pyramid building block: Config
Pyramid building block: Models
Pyramid building block: Templates​

Your first service

Introducing the car dealer service
Creating the web app
Running in pycharm
Concept: Creating the site
Project structure
Reorganizing the project for APIs
Implementing the API
Adding data
Concepts: Implement the API​

Calling services with Python and JavaScript

Calling services with Postman
Calling services with Python clients
Calling services with JavaScript clients
Enabling cross-domain requests with CORS​

A nearly RESTful service

A nearly RESTful service introduction
Creating cars, RESTfully
Concept: RESTfully creating cars
Updating cars, RESTfully
Concept: RESTfully updating cars
Deleting cars, RESTfully
Concept: Deleting cars, RESTfully
Introducing renderers
The problem: JSON renderer for custom types
Extending JSON renderer for custom types
Concept: JSON renderer for custom types​

Customer Renderers

Introduction to renderers
Adding a CSV renderer
Generating both CSV and JSON responses
Adapting non-standard types
Generating image-based responses with renderers (v1)
Generating image-based responses with renderers (v2)
Common renderer types via ABCs (abstract base classes)
Adding the JSON renderer to the ABCs (abstract base classes)​

Content negotiation

What is content negotiation?
Adding a negotiating renderer
Realistic accept headers
Concept: Negotiating renderer​

Validation with view models

Adding validation to APIs (never trust input)
Concept: Adding validation to APIs
Moving validation to view models
Improved car object creation
View model classes
Concept: View models​

Adding a database backend with SQLAlchemy

Introducing SQLAlchemy
Getting started SQLAlchemy
Database sessions
Unit of work and the session factory
Modeling classes
Creating tables
Updating the repository to use SQLAlchemy
Concept: SQLAlchemy building blocks​

Authenticated services

Setting up users
Creating a few users
Passing the API key
Isolating the API auth features
Authorization concepts​

Logging and monitoring

Why you want monitoring and logging
Introducing logbook
Setting up logbook
Using logbook
Exploring Rollbar for real-time monitoring​

Deploying your REST service to DigitalOcean on Ubuntu

How we deploy Python on nginx, uWSGI, and Ubuntu
DigitalOcean overview
Creating your ssh key
Create and configuring the droplet (server)
Configure uWSGI
Configuring nginx
Concepts: Deployment​

Documenting your API

Documentation options
Adding the documentation views
The documentation HTML and CSS​

Conclusion

You've done it!
Lightning review: What is REST?
Lightning review: Web building blocks
Lightning review: Creating the service
Lightning review: API view methods
Lightning review: Content negotiation
Lightning review: View models
Lightning review: SQLAlchemy
Lightning review: API keys
Lightning review: Logging and monitoring
Lightning review: Deployment
Lightning review: Docs
Thanks and bye​