Panoramic view of web APIs
- 1. PANORAMIC VIEW OF WEB API - Karen Immanuel
- 2. WHAT IS AN API? Application Programming Interface It provides the conventions to interact with applications without knowing the internal logic of the code Examples:
- 3. BUILD AN API FOR YOUR CODE Source : Google images
- 4. REQUEST PARAMETERS OF API URL Request parameters https://forkify-api.herokuapp.com/api/search?q=pizza Authorization: - No auth - Password based - API Key based - Token based Http verb: - GET - POST - PUT - DELETE
- 5. RESPONSE PARAMETERS OF API Source : Google images
- 6. REST API Create (SQL INSERT) : POST – Create a resource Read (SQL SELECT) : GET - Retrieve a representation of a resource Update (SQL UPDATE) : PUT - Update a resource using a full representation Delete (SQL DELETE) : DELETE - Delete a resource. C R U D • Based on seven principles • Representation of Resources -> URL Example: http://example.com/api/books • Basic operations on resources - CRUD
- 7. EXAMPLE Sample Data source ❑JSON data ❑Can also be from DB FLASK IMPLEMENTATION
- 8. API TO PERFORM BASIC CRUD OPERATIONS
- 9. API TO PERFORM BASIC CRUD OPERATIONS
- 10. API TO PERFORM BASIC CRUD OPERATIONS
- 11. API TO PERFORM BASIC CRUD OPERATIONS
- 13. LONG RUNNING TASKS Example – Sending an email It can block the API.
- 14. LONG RUNNING TASKS – BACKGROUND TASKS ▪Need non-blocking request/responses ▪Task Queue – Celery Source : Google images
- 15. THREADING VS. TASK QUEUE 1. Task queues have distributed architecture 2. Scales application extremely well 3. Add more workers according to load 4. Does not block the API
- 16. STATUS OF BACKGROUND TASK Client will know that background task started. Update status in non blocking way ➢Polling ➢Web socket ➢Server sent events Source : Google images
- 17. API DOCUMENTATION WITH SWAGGER TOOL oGood documentation is essential for APIs oTake care of versioning and backward compatibility <code snippet of swagger plugin in flask> Output of a well- organized API doc Source : Google images
- 18. SERVERLESS DEPLOYMENT WITH ZAPPA While developing, APIs run on local server For your APIs to be accessed by clients/3rd party users, they must be in a server. Instead of dedicated server, we can go serverless For personal projects or quick testing we can go with the option of serverless deployment. Easy to setup Demo/screenshot of serverless deployment with Zappa