Documentation-driven development for Python web APIs
Download as PPTX, PDF0 likes236 views
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.
Documentation-driven development for Python web APIs
- 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
- 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