This document outlines an agenda for a presentation on API design principles and best practices. The presentation covers: 1. A brief introduction to APIs and the momentum around them. 2. Key API design principles such as discoverability, abstraction, versioning, standardized contracts, autonomy, longevity, naming conventions, security, and orchestration. 3. A live demonstration using Apiary.io to validate API design and show code examples. The presentation aims to provide guidance on how to design good APIs.

1. API Design Principles. Good Practices with Oracle
Apiary.io
Oracle Developer Tour. August 8th 2018.
Digital Transformation.
S&P Solutions
Rolando Carrasco
rcarrasco@spsolutions.com.mx
Twitter: @borland_c
Blog: oracleradio.blogspot.com
Linkedin: linkedin.com/in/rolandocarrasco/
Blvd Manuel Avila Camacho #36-10
Lomas de Chapultepec CP 11000
+52 55 91721478

2. AGENDA
1. API. A brief introduction.
2. API Context. The momentum.
3. API Design principles.
4. CLI utilities and StyleGuide to validate your API
Design. Live Demo. Live Coding.

3. S&P Solutions
Part of our work. Published books.
02

4. S&P Solutions 03
New
http://oracle-integration.cloud/
(2017)
New
http://apiplatform.cloud/
(2018)
Technical
Reviewer
Part of our work. Published books.

5. S&P Solutions
Oracle ACE. Red Expert Alliance. Developer Champion.
04
http://www.oracle.com/technetwork/community/oracle-ace/index.html
https://www.redexpertalliance.com/map-page/
https://blogs.oracle.com/developers/ne
w-developer-champion-program

6. Digital Transformation turned me
speachless. Thank u APIs!!!
05

7. But…are we living on
a hAPI world?
What do u think?
06

8. Are we living on a
hAPI world?
What do u think?
07
https://www.programmableweb.com/news/research-shows-interest-providing-apis-still-
high/research/2018/02/23?_lrsc=deb9ff17-8477-4d0e-9f43-9c050e3deb83

9. APIs here, there and everywhere.
08
https://www.gizmodo.com.au/2015/11/is-australia-ready-for-a-more-connected-world/

10. API Economy
09
Source: http://developer.IBM.com

11. Market pressure. New way to deploy
applications and functionality. BI Modal IT
10

12. Ultimately, what is an API?
11
1. First of all we are talking about Web APIs during this
presentation. That is our interest for the upcoming 40
minutes
2. What is the relationship with:
• Web Services
• Services
• Microservices
• Functions

13. 12
API = Web Services = Services = MicroService = Function
(?)

14. 13
They are not the same thing.
Not …at all. They look alike,
but are different things.
https://streetsmartbrazil.com/different-part-2/

15. Key elements to take care about
our APIs
15
1. While SOA is targeted to reduce costs, through services
reusability, APIs are targeted to generate money.
External APIs may have that purpose.
2. An API is a product for your company. It needs to be well
designed, well presented, well documented
3. It has to be designed to be durable. For longevity and
not ephimeral

16. 17
It’s your product. C’mon! Do
not hesitate on good design.
http://thjomas.com/39-shocking-famous-product-designers-photo-design/famous-product-designers-youtube-shocking-photo-design/

17. 18
We need to build ready-to-use APIs.
http://www.campbellsoup.ca/en-ca/products/campbells-broths/campbells-ready-to-use-vegetable-broth

18. 19
API First, Contract First, Design First!!
http://www.campbellsoup.ca/en-ca/products/campbells-broths/campbells-ready-to-use-vegetable-broth
Really??

19. 20
APIs are the cornerstone for Digital
Transformation. U better design them well
https://thermomix.com/
APIs are building blocks for Digital Transformation.
They enable different channels & create new
businesses.
Copyright https://medium.com/apis-and-digital-transformation/how-api-management-accelerates-digital-business-4ccea9b302df

20. APIs design principles
21
1. Discoverability
2. Abstraction
3. Versioning
4. Standardized Service Contract. Uniform Contract.
5. Autonomy
6. Longevity and Durability
7. Naming Convention
8. Security
9. Orchestration. Late Binding. HATEOAS.

21. 22
But…how can I design good APIs?

22. 23
What’s next?

23. 24
What’s next?
Let’s demonstrate it
using Apiary.io

24. Here we go