API First: REST API Design Using ADDR
Design Great APIs with Confidence
This workshop will enable your organization to:
- Gain hands-on experience designing REST-based APIs that improve reuse while remaining agile
- Include product managers, architects, and developers in the API design process
- Meet the needs of your business, partners, and customers through efficient API design
- Scale your organization’s API efforts with a repeatable API design-first process
- Improve the quality of your new and existing APIs
The workshop combines short lectures with hands-on lab exercises help teams apply the full ADDR process.
We offer multiple delivery options to meet your needs:
- Private Instructor-led corporate workshops support up to 30 participants to provide opportunities for collaborative API design.
- Enterprise licensing supports self-paced workshops to scale up your training across your entire organization
- Public Instructor-guided workshops support self-paced learning with exercise feedback for a robust learning experience
Workshop overview
The workshop is built upon the “Align-Define-Design-Refine” (ADDR) API design first process. The ADDR process applies an outside-in approach to API design with a focus on jobs-to-be-done that produce desired outcomes. This process is featured in the book titled, “Principles of Web API Design”, published by Addison Wesley as part of the Vaughn Vernon Signature Series.
The workshop is divided into five units, with lecture and hands-on exercises that explore the various activities that help you through the API design process:
1. Establishing a Scalable API-First Design Process
Why Do We Need an API Design Process? • Delivering Outcomes Through Digital Capabilities • Overview of the ADDR Process
2. Aligning on Digital Capabilities and Outcomes
Aligning on Your API Needs • Identify Digital Capabilities Using Job Stories • Walkthrough: How to Write a Job Story • Exercise: Writing Job Stories • Capturing Activity Steps • Walkthrough: Identifying Activity Steps • Exercise: Complete the Activity Steps • An Introduction to EventStorming
3. Transform Outcomes and Activities into an API Profile
Finding API Boundaries • Walkthrough: Finding API Boundaries • Modeling API Profiles • Walkthrough: Modeling an API • Exercise: Model Your API • Validating API Profiles Using API Sequence Diagrams • Exercise: Validating API Profiles Using API Sequence Diagrams
4. From API Profile to a REST-based API Design
Review of REST API Principles • Applying ADDR to REST API Design • Walkthrough: Creating a High-Level REST API Design • Exercise: Complete the API REST Design
5. Refining Your REST API Through Rapid Feedback
Validating API Design Using Sequence Diagramming • Exercise: Validating API Design Using API Sequence Diagrams • Refining the REST API Design Through Mocking • Exercise: README Mocking • Capturing Your Working API Design Using OpenAPI Specification (OAS) • Exercise: Create your OpenAPI Document
Need something added or modified? We offer course customization for instructor-led delivery.
Workshop pre-requisites
Attendees should be familar with the following concepts:
- API fundamentals, including HTTP methods such as GET/POST/PUT/PATCH/DELETE and common HTTP response codes
- REST-based principles and practices, including applying the create-read-update-delete (CRUD) pattern
- JSON object structures to represent resources within a high-level API design
- The OpenAPI specification, including basic composition using YAML or JSON to document a REST-based API with minimal guidance
If attendees would benefit from a brief refresher course on these topics, we suggest first completing the “Fundamentals of Web APIs” Workshop. Or, combine both courses as part of an enterprise license and deliver and end-to-end training solution for your organization. More details are in the next section.
Get Started: Select Your Delivery Format
We offer three delivery options for this workshop:
Option 1. Instructor-Guided Online Course for Individuals
A self-paced course that is designed for product managers, product owners, architects, and developers responsible for designing and delivering web APIs. You will experience short lectures along with step-by-step walkthroughs, plus hands-on exercises to apply what you have learned. Each exercise is submitted to an instructor for feedback and learning, along with a solution walkthrough, giving you an experience similar to live workshops - at your own pace.
Option 2. Private Corporate Workshop
Traditional instructor-led delivery across three half-day sessions, delivered virtually. This is perfect for geographically distributed teams and provides a cost-effective option compared to in-person delivery. On-site delivery is available for an additional fee, based upon location and availability.
Option 3. Enterprise Site License
For larger organizations that need to upskill lots of teams quickly, this option supports self-paced learning videos and exercises. Upskill your staff across the organization, today and into the future.
No per-seat licenses or yearly renewals. You will also receive the slides for all content, enabling you to customize any of the lessons to meet your needs. Videos are delivered in mp4 format for posting on an internal website. We also offer content using the SCORM format, making it easy to import into your learning management system (LMS) for continuing education credit.
Need more information?
Email: training@launchany.com
Phone: (512) 537-8493