Automating REST API Contract Documentation with Confluence, Postman & Python

At a certain point, our team encountered several issues:

• Unsynchronized descriptions of REST API contracts.

• Multiple sources of truth.

• Multiple teams sharing responsibility for keeping the documentation up to date.

In this talk, I’ll share how we addressed these challenges using Confluence, Postman, Python — and a strong desire to work fast and efficiently.

We focused on:

• Consolidating documentation into a single source of truth.

• Synchronising all information storage points.

• Defining a responsible group to drive a clear and efficient API design process.

As a result:

• The team got a convenient and intuitive tool.

• Achieved 100% synchronization with minimal handovers to the contract owner.

• Reduced API testing time from 1.5 – 2 days to just 2 hours.