Camila Maia - ScanAPI

Automate integration tests and generate live documentation for APIs with ScanAPI, an open-source framework used by Loadsmart and contributed to by Camila Maia. Learn how to overcome common challenges and get started today!

Key takeaways
  • ScanAPI is an open-source framework for automating integration tests and generating live documentation for APIs.
  • The speaker, Camila Maia, is a developer at Loadsmart, a logistics company, where she worked as a firefighter and contributed to the creation of ScanAPI.
  • ScanAPI can be used to automate integration tests, generate live documentation, and provide real-time information about API requests.
  • The framework uses a YAML or JSON file to specify the API endpoints and their behavior, and can be run locally or in CI/CD pipelines.
  • Camila shared her personal experience with integrating ScanAPI into a project, discussing the challenges she faced and how she overcame them.
  • The first kind of problem was integration errors, which required recreating scenarios in production and using dynamic endpoint testing.
  • The second kind of problem was outdated documentation, which made it difficult to understand the API’s behavior.
  • The third kind of problem was the difficulty in recreating scenarios, which required manually testing and debugging.
  • Camila emphasized the importance of open-source contributions and the benefits of using ScanAPI for automating integration tests and generating live documentation.
  • She also mentioned that ScanAPI is written in Python and can be used with other frameworks, such as DRF or Flask.
  • The speaker encourage attendees to join the ScanAPI community and chat room to learn more about the framework and ask questions.
  • The talk concluded with a demonstration of how to use ScanAPI and a call to action for attendees to get involved.