ScanAPI Workshop. DjangoCon EU 2022

Slide 1

Slide 1 text

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

Slide 2

Slide 2 text

You can this presentation at: speakerdeck.com/cmaiacd

Slide 3

Slide 3 text

Who am I?

Slide 4

Slide 4 text

Backend Developer @

Slide 5

Slide 5 text

Coding since 2010 👵

Slide 6

Slide 6 text

Python 🐍 and Ruby 💎

Slide 7

Slide 7 text

Community ❤

Slide 8

Slide 8 text

Motivation

Slide 9

Slide 9 text

Everything started in a week which I as Fireﬁghter 🔥

Slide 10

Slide 10 text

Integration Errors 💥 Client sending ﬁelds different than what’s expected Frontend receiving ﬁelds different than what’s expected

Slide 11

Slide 11 text

Missing endpoints Missing ﬁelds Misinformation Outdated documentation 📜

Slide 12

Slide 12 text

/book/:seat_id ﬂight_id? airplane_id? passenger_id? Is the airplane available? ???? Hard to recreate complex scenarios 😤

Slide 13

Slide 13 text

No content

Slide 14

Slide 14 text

No content

Slide 15

Slide 15 text

What is it?

Slide 16

Slide 16 text

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

Slide 17

Slide 17 text

1. Provide a Live Documentation

Slide 18

Slide 18 text

2. Tool to implement Integration Tests

Slide 19

Slide 19 text

Speciﬁcation Files Report For each request: - Hit the endpoints - Run the tests

Slide 20

Slide 20 text

Why should I use ScanAPI? 7 reasons!

Slide 21

Slide 21 text

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

Slide 22

Slide 22 text

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

Slide 23

Slide 23 text

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

Slide 24

Slide 24 text

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

Slide 25

Slide 25 text

5. It is simple

Slide 26

Slide 26 text

6. It is ﬂexible

Slide 27

Slide 27 text

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

Slide 28

Slide 28 text

+1.5k + 1.2k ⭐

Slide 29

Slide 29 text

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

Slide 30

Slide 30 text

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