Explore a conference talk that delves into leveraging documentation to enhance web APIs. Learn how to utilize code documentation and type systems to create more accessible, understandable, and testable APIs. Discover techniques for generating explorable APIs, improving error messages, and implementing automatic testing. Gain insights into using Python's dynamic capabilities to explore and exploit code and documentation, and understand the advantages and limitations of this approach compared to other methods. Examine features such as browsable APIs, input/output verification, automatic serialization, smart exception handling, and automated testing. Uncover lessons learned from this experimental approach and explore potential future developments in API documentation and functionality.
Overview
Syllabus
Intro
Context
What?
Features
Use documentation
Json & Jsonschema
Automated In/Output Validation & Conversion
Automated Html Form & Validation
Automated testing
User "Friendliness"
What's next?
Summary
Taught by
EuroPython Conference