API First Design
Insights from the real-life usage
Who we are ● Klaus Peter Laube (@kplaube)
● Technologist in Systems Analysis (UNERJ)
● Blogger
○ profissionaisti.com.br
○ klauslaube.com.br
● Software Engineer at Loadsmart for almost 2
years
Who we are
API First "(...) is about a series of best practices across
companies and industries that prioritize a better
developer experience (DX).
- ProgrammableWeb
API First "(...) is about a series of best practices across
companies and industries that prioritize a better
developer experience (DX).
- ProgrammableWeb
It's also about business!
In practice
Plan & Project
01
In practice
Plan & Project
Validate
01
02
In practice
Plan & Project
Validate
Test
Write the code
01
02 03
04
In practice
Plan & Project
Validate
Test
Operate & Engage
Write the code
05
01
02 03
04
Lessons
learned
- API First is not about picking technology
Lessons
learned
- API First is not about picking technology
- API contracts should be the single source of truth
Lessons
learned
- API First is not about picking technology
- API contracts should be the single source of truth
- Consider using older Spec versions
Lessons
learned
- API First is not about picking technology
- API contracts should be the single source of truth
- Consider using older Spec versions
- Write code that writes code
References
● Cornell CSI - Software design
● Ivan Vaskevych - API First approach with Swagger
● John D. Cook - Top down, bottom-up
● ProgrammableWeb - How To Design Great APIs With API-First
Design
● SlideShare - Definition Driven API Development: How OAS &
Swagger Help Teams Streamline Their API Development
● SlideShare - Exploring and Integrating UX in Open Source
Software Development
● Wikipedia - Top-down and bottom up design
● Youtube - Bottom Up vs Top Down Design in Clojure - Mark
Bastian
We are hiring!
https://loadsmart.com/careers/

Api First Design

  • 1.
    API First Design Insightsfrom the real-life usage
  • 2.
    Who we are● Klaus Peter Laube (@kplaube) ● Technologist in Systems Analysis (UNERJ) ● Blogger ○ profissionaisti.com.br ○ klauslaube.com.br ● Software Engineer at Loadsmart for almost 2 years
  • 3.
  • 5.
    API First "(...)is about a series of best practices across companies and industries that prioritize a better developer experience (DX). - ProgrammableWeb
  • 6.
    API First "(...)is about a series of best practices across companies and industries that prioritize a better developer experience (DX). - ProgrammableWeb It's also about business!
  • 7.
  • 8.
    In practice Plan &Project Validate 01 02
  • 9.
    In practice Plan &Project Validate Test Write the code 01 02 03 04
  • 10.
    In practice Plan &Project Validate Test Operate & Engage Write the code 05 01 02 03 04
  • 11.
    Lessons learned - API Firstis not about picking technology
  • 12.
    Lessons learned - API Firstis not about picking technology - API contracts should be the single source of truth
  • 13.
    Lessons learned - API Firstis not about picking technology - API contracts should be the single source of truth - Consider using older Spec versions
  • 14.
    Lessons learned - API Firstis not about picking technology - API contracts should be the single source of truth - Consider using older Spec versions - Write code that writes code
  • 15.
    References ● Cornell CSI- Software design ● Ivan Vaskevych - API First approach with Swagger ● John D. Cook - Top down, bottom-up ● ProgrammableWeb - How To Design Great APIs With API-First Design ● SlideShare - Definition Driven API Development: How OAS & Swagger Help Teams Streamline Their API Development ● SlideShare - Exploring and Integrating UX in Open Source Software Development ● Wikipedia - Top-down and bottom up design ● Youtube - Bottom Up vs Top Down Design in Clojure - Mark Bastian
  • 16.