Getting started with API documentation tools in modern development workflows

Hi everyone 👋

I’m currently exploring different tools and approaches for API documentation and testing, especially in modern development workflows involving microservices and external integrations.

As a beginner/intermediate developer, I’ve noticed that API documentation is often:

outdated quickly
disconnected from actual testing
hard to maintain across teams

So I’ve been trying to understand what real-world teams use to solve this problem.

Some common approaches I’ve seen so far:

OpenAPI / Swagger-based documentation
Separate tools for testing and documentation
Integrated platforms that try to combine both workflows

One tool I came across during my research is Apidog, which combines API design, testing, and documentation in a single workflow. It looks interesting for keeping everything in sync, especially for small teams.

I’m still learning though, so I’d love to hear from more experienced developers:

👉 What do you use for API documentation in your projects?
👉 How do you make sure your docs stay updated as your API evolves?
👉 Any tools or workflows you would recommend for someone starting out?

Thanks in advance for sharing your experience

Comments

[luc]

Good starting point. In practice, most teams reduce drift by making the spec the source of truth and automating docs + tests in CI. Tools like Apidog are often used to keep design, testing, and documentation tightly in sync.

[John Carter]

Exactly spec-first and CI automation is what keeps things from drifting

[Herve]

Some teams solve it by using tools like Apidog to keep API design, testing, and documentation in sync in one workflow.