The presentation by Jose Haro Peralta covers documentation-driven development for Python web APIs, emphasizing its importance in simplifying API integrations. It outlines strategies such as utilizing specifications, validating implementations, and employing tools like Dredd and Schemathesis for testing. Additionally, it provides insights into building API clients and ensuring continuous integration and deployment.

1. Documentation-driven
development for
Python web APIs
• Jose Haro Peralta
• Full stack consultant
• Cofounder of microapis.io
@JoseHaroPeralta
@microapisio
EuroPython 2021

2. $ whoami
35% discount code: ctweuro21
• I’m Jose
• Independent contractor | London
• Full stack developer
• Microservices and APIs
@JoseHaroPeralta
@microapisio

3. microapis.io
39% discount code: ctwapi21
One-click API mock servers
@JoseHaroPeralta
@microapisio

4. Connect with Jose
• Twitter: @JoseHaroPeralta
• GitHub: @abunuwas
• Medium: @joseharoperalta /@python-geek
• LinkedIn: https://www.linkedin.com/in/jose-haro-peralta/
@JoseHaroPeralta
@microapisio

5. This
presentation
covers
• Complexity of API integrations
• What is documentation-driven development and why
it matters?
• How to you can adopt documentation-driven
development?
• REST API (OpenAPI)
• FastAPI
• Validate server implementation with Dredd and
schemathesis
• Build API clients with mock servers
• Continuous Integration and deployment to Heroku
• API visibitility
• Code for this presentation:
https://github.com/abunuwas/europython-2021
@JoseHaroPeralta
@microapisio

6. API integrations are tricky
API server
API client
12/12/2020 vs 12-12-2020

7. Misunderstandings drive API integration
failures
• Misunderstanding about data formats
• "2021-07-29" vs "2021/07/29"
• "$21" vs 21
• true vs "True"

8. Misunderstandings drive API integration
failures
• Misunderstanding about data types
• "2021" vs 2021
• 202.1 vs 202

9. Misunderstandings drive API integration
failures
• Misunderstanding about optional fields
vs

10. Misunderstandings drive API integration
failures
• Misunderstanding about the usability of the endpoints

11. How API
integrations
fail
Lack of
documentation
Bad documentation
Lack of design stage

12. What is API documentation?
REST -> OpenAPI
GraphQL -> Schema Definition
Language
gRPC -> Protobuf

13. What is
documentation-
driven
development?
• Also known as design-first, API-first
or contract-first approach
• Design and produce the API
specification first
• Build your server and your API
client (if you have one) against the
specification
• Use the specification to validate
your implementation

15. Dredd / schemathesis

17. datamodel-code-generator
(https://github.com/koxudaxi/datamodel-code-generator)

19. Run Dredd tests with hooks

20. Run schemathesis tests with stateful links

21. Running a mock server with prism

22. Calling a mock server with prism

23. Running a mock server with microapis.io

24. Calling a mock server with microapis.io

25. Configuration for the Travis file

26. Thanks for listening!
Twitter: @JoseHaroPeralta
GitHub: @abunuwas
Medium: @joseharoperalta /@python-geek
LinkedIn: https://www.linkedin.com/in/jose-haro-peralta/
35% discount code: ctweuro21