Presentation about API design

1. API Design
Marcelo Cure / Thales Melo

2. Why should I care?
● It’s your company’s front door
● This is how you can earn some money
● This is how you can scale your system
● This is how you can centralize operations

3. Who are my consumers?
● Who are my consumers?
● How will they access my API?
● How many requests are expected?
● Which consumer profiles will exist?

4. Security
● Why should I care?
● Authentication
● Authorization

5. REST … remember?

6. Contracts, discuss contract changes …
...do it cautiously
… involve more people

7. Contracts, future perspective …

8. Contracts, postpone decisions …

9. Contracts, flexibility …

10. Contracts and consumers …
Comply with your consumers ….
...do not surrender to them

11. Contracts, T E S T S…

12. Versioning
● What is?
● Why versioning?
● Strategies
● Too many versions :/
● Deprecating old versions

13. Standards

14. Documentation
● Why is documentation important? (internally/externally)
● Write proper documentation, swagger sucks

15. Recommended reading
https://martinfowler.com/articles/consumerDrivenContracts.html
https://pt.slideshare.net/rnewton/api-design-methodology-mike-amundsen-director-of-api-architecture-api-
academy-apidays-sydney
https://www.infoq.com/br/profile/Mike-Amundsen/
https://medium.com/@__cure/importance-of-documenting-your-api-eb96ec2612f6
https://medium.com/@__cure/semantic-versioning-408b21128683
https://medium.com/@__cure/rest-anti-patterns-b128597f5430

16. Exercise, mother fuckers
API da NETFLIX - Subscriptions
● CRUD de usuários
● CRUD de gênero
● CRUD de filmes
● CRUD de séries
● CRUD de documentários
● subscription de filmes de uma gênero para um usuário (deve informar como receber novidades ... email, sms, zapzap)
● subscription de séries de uma gênero para um usuário (deve informar como receber novidades ... email, sms, zapzap)
● subscription de documentários de uma gÊnero para um usuário (deve informar como receber novidades ... email, sms, zapzap)
● busca de filmes de um subscription de um usuário
● busca de séries de um subscription de um usuário
● busca de documentarios de um subscription de um usuario