Requirements & API
Foreword
In recent years, I wrote several materials about API design and last year (2023) did a local workshops and online webinars titled "Requirements & API" targeted for Business Analysts and Product Owners who want to learn aobut APIs. Since then, I have had an idea to expand and restructure the content by making it more accessible. Original blog posts lacked some storytelling consistency, and workshops/webinars were for the Russian-speaking audience. So now I am doing the final step to revise that material and extend it further continuously.
We start from scratch, uncovering what API means, what place it takes in the world of software requirements, and what components are critical to addressing. Then, we proceed to more advanced topics I want to uncover: Interface Definition Languages and API tooling.
Below is a plan with all the topics I plan to cover (some even for a 3rd time). Stay tuned for the updates!
Chapters
- Glossary
- Definitions
- Analysis
- Structure
- Interface Definition Language (IDL)
- IDL: OpenAPI
- IDL: JSight
- IDL: Typespec
- API Sequence Definition
- API Sequence: OpenAPI Workflows