apidays LIVE JAKARTA - Connecting the Digital Stack 359o of API Design: Things to consider when crafting your API Specification Ariyandi Widarto, Software Engineer at DANA

1. 359o
of API Design
Things to Consider when Crafting API Specification
Ariyandi Widarto
September 2020

2. API to Connect the Digital Stack
Engineer
Business
Product
Finance
HR
Analogy

3. API to Connect the Digital Stack
En
Bu
Pr
Fin
H
En
Bu
Pr
Fin
H
En
Bu
Pr
Fin
H
Analogy

4. API to Connect the Digital Stack
Analogy

5. API to Connect the Digital Stack
Analogy
APIAPI
API
API
API
API

6. So, what are the
things to consider?

7. Hold on a bit, before that,
what is the impact if we
don’t do proper API design?

8. Image by raygun.com
Cost

9. Business Goal
Image by clipart.email

10. How to Measure
the Quality of API?

11. - Business Requirement
- Idempotent & concurrency
- Standards
- Documentation
- Backward compatibility
- Extensibility in the future
- Testing
- Monitoring & tuning - Security standards

12. Business Requirement
Use cases Business rules

13. Idempotent & Concurrency

14. Compatibility & Extensibility
100% backward compatible
API migration
Easy to extend and scale

15. Security
Image by en.wikipedia.org
Image by business2community.com
HTTPS, IP whitelist, firewall, sensitive data encryption, PCIDSS, ISO standards, etc…….
Image by docs.oracle.com

16. • Naming convention
• Path convention
• HTTP method convention
• Header & body format
• API timeout
• Logging convention
• Effective and structured documentation
Standards & Documentation

17. Testing
• Complete and well documented UAT
• Positive cases
• Negative cases
• Idempotent cases
• Concurrency cases
• Performance testing
• Load testing
• A/B testing

18. Monitoring & Tuning
TPS target Monitoring dashboard
Limiter & switch Technical improvement

19. –Prometheus
“Big things have small beginnings.”

22. Thank you!
I’m very interested if you have some other perspective, feel
free to send me an email to discuss (ariyandi.widarto@dana.id).