ScanAPI Workshop. DjangoCon EU 2022

https://pretalx.evolutio.pt/djangocon-europe-2022/talk/AFYRWB/

Transcript

1. WORKSHOP: Automated Integration Testing and Live Documentation
   for your Django APIs
   DjangoCon EU 2022 - Porto
   Camila Maia
   

   View Slide

2. You can this presentation at:
   speakerdeck.com/cmaiacd
   

   View Slide

3. Who am I?
   

   View Slide

4. Backend Developer @
   

   View Slide

5. Coding since 2010
   👵
   

   View Slide

6. Python 🐍 and Ruby 💎
   

   View Slide

7. Community ❤
   

   View Slide

8. Motivation
   

   View Slide

9. Everything started in a week which I as
   Firefighter 🔥
   

   View Slide

10. Integration Errors 💥
    Client sending fields
    different than what’s
    expected
    Frontend receiving fields
    different than what’s
    expected
    

    View Slide

11. Missing endpoints
    Missing fields
    Misinformation
    Outdated documentation 📜
    

    View Slide

12. /book/:seat_id
    flight_id? airplane_id?
    passenger_id?
    Is the airplane available?
    ????
    Hard to recreate complex scenarios 😤
    

    View Slide

13. View Slide

14. View Slide

15. What is it?
    

    View Slide

16. Open Source Framexwork
    Command Line Interface (CLI)
    Written in Python
    

    View Slide

17. 1. Provide a Live Documentation
    

    View Slide

18. 2. Tool to implement
    Integration Tests
    

    View Slide

19. Specification Files Report
    For each request:
    - Hit the endpoints
    - Run the tests
    

    View Slide

20. Why should I use ScanAPI? 7 reasons!
    

    View Slide

21. 1. It works for any REST API,
    it doesn't matter how it
    was built
    

    View Slide

22. 2. It is extremely useful for
    testing and documenting
    both owned and third-party
    APIs
    

    View Slide

23. 3. It is possible to chain
    requests, which is essential
    for testing complex
    scenarios
    

    View Slide

24. 4. The documentation is
    automatically generated, it
    never gets outdated
    

    View Slide

25. 5. It is simple
    

    View Slide

26. 6. It is flexible
    

    View Slide

27. 7. There is nothing in the
    market that does what
    ScanAPI does!
    

    View Slide

28. +1.5k
    + 1.2k ⭐
    

    View Slide

29. scanapi.dev Tutorial
    github.com/camilamaia/
    scanapi-tutorial
    

    View Slide

30. GitHub
    - https://github.com/scanapi
    Twitter
    - @ScanAPI_
    Discord
    - discord.scanapi.dev
    Communication
    

    View Slide

31. github.com/scanapi
    ❤
    

    View Slide

32. Let’s use it!
    

    View Slide

33. And share it! 🚀
    

    View Slide

34. THANK YOU!
    @cmaiacd camilamaia
    󰠁
    cmaiacd.com
    

    View Slide