Better Programming

Advice for programmers.

Follow publication

Member-only story

Designing Sequence Diagrams for API Orchestration

Songtham Tung
Better Programming
Published in
6 min readDec 24, 2021

Image by author

Sequence diagrams help visualize what happens when an action occurs — such as when a user presses a button on your app. They are commonly used by technical and business teams to architect solutions, understand requirements for new system integration and/or to document an existing process.

While sequence diagrams can be applied to various scenarios, in this article, we will go over how to design sequence diagrams for API orchestration. You’ll need to be familiar with APIs or application program interfaces, which basically enable different apps to communicate with each other via an exchange of requests and responses. I’ve written a separate blog going over how to read API documentation here. API orchestration is the act of chaining these separate calls together to solve a problem.

Begin with the Use Case

What problem are you trying to solve? This is the first question that you should ask when designing a sequence diagram. API orchestration begins with the use case, followed by the available APIs — and not the other way around.

Create an account to read the full story.

The author made this story available to Medium members only.
If you’re new to Medium, create a new account to read this story on us.

Or, continue in mobile web

Already have an account? Sign in

Songtham Tung
Songtham Tung

Written by Songtham Tung

Technical Account Manager | 1M+ Reads | 🇺🇸🇹🇭

Write a response

Nice piece Songtham!!

1

Websequencediagrams.com for the win. I hope it doesn’t get overwhelmed with traffic.

1

It’s the come back of the functional specifications. How many times could you estimate the time to build specifications, the time to build code and the time to test one feature? Do you think 1/3 1/3 1/3 is a good estimate?