Generating & Using AsyncAPI Specs from Real-World API Data- Natalie Edson,Rob Galanakis,Lithic Tech
AsyncAPI Conference 2022 - Day 3 5th November 2022 One of the challenges of working with 3rd party APIs is the unreliability of their data schemas. Missing or incorrect specifications and documentation contribute to a very real problem—any code built against these schemas cannot be relied on as correct until you collect enough examples to prove that it is likely not-incorrect. This causes issues throughout the development process, from poor-quality canned test data to bugs and errors in production. A good way to solve this is by regenerating AsyncAPI specifications from the 3rd party API data you have available, and using these specifications to validate live data, generate examples for unit tests, and eventually self-improve the specifications. We will demonstrate how this approach solved real problems on the API integration product WebhookDB by: 1) creating a comprehensive regression testing system, built on AsyncAPI specifications generated by data we captured in the real world; 2) providing access to the AsyncAPI specifications of 3rd party APIs supported on WebhookDB, thereby paying forward the investment made into AsyncAPI to potentially improve users' applications and data pipelines.
AsyncAPI Conference 2022 - Day 3 5th November 2022 One of the challenges of working with 3rd party APIs is the unreliability of their data schemas. Missing or incorrect specifications and documentation contribute to a very real problem—any code built against these schemas cannot be relied on as correct until you collect enough examples to prove that it is likely not-incorrect. This causes issues throughout the development process, from poor-quality canned test data to bugs and errors in production. A good way to solve this is by regenerating AsyncAPI specifications from the 3rd party API data you have available, and using these specifications to validate live data, generate examples for unit tests, and eventually self-improve the specifications. We will demonstrate how this approach solved real problems on the API integration product WebhookDB by: 1) creating a comprehensive regression testing system, built on AsyncAPI specifications generated by data we captured in the real world; 2) providing access to the AsyncAPI specifications of 3rd party APIs supported on WebhookDB, thereby paying forward the investment made into AsyncAPI to potentially improve users' applications and data pipelines.