API first development with OpenAPI

API First development – should you practise it?
Of course.

In this talk, I’ll show you how OpenAPI can make your life easier in a serverless world:

- Creating the contract with your consumers is the first thing you do
- You can automatically create your API from this OpenAPI definitions (e.g. skip the whole configuration of your API Gateway on AWS by using OpenAPI)
- You’ll have a beautiful visual overview of your API
- Generate your class definitions based on this OpenAPI definitions
- Validate incoming and outgoing requests with the OpenAPI definition

Did you notice that I just gave you five advantages of using OpenAPI?
It’s only the beginning.
And that’s why you should practice API First development with OpenAPI.

Transcript

1. Titel Onderwerp Verantwoordelijke afdeing, personen. Datum API-first-development with OpenAPI Nick Van Hoof 2019-10-15 @TheNickVanHoof
2. 2 § Nick Van Hoof § Cloud Developer § Ordina § https://ordina-jworks.github.io/ § https://nickvanhoof.com Whoami
3. 3 § API first development § Open API § Open API in practice Content § No demo’s § Movies § Valuable info
4. 4 §API 3 §API
5. 5 WHY API-FIRST § Business value § Teams work separately § More and more APIs
6. 6 HOW API-FIRST § Communication § Visualization § Sound agreements
7. 7 WHAT API-FIRST §API FIRST DEVELOPMENT
8. 8 WITH API-FIRST §OPEN API
9. 9 § API first development § Open API § Open API in practice Content
10. 10 200 202 404 400 What happens when we don’t think about our API?
11. 11 Using OPEN-API
13. 13 OPEN-API
14. 14 api.yml 14 api.yml
15. 15 Open API Visualization – communication
16. 16 § API first development § Open API § Open API in practice - Creating API compliant code - Integrating with build process - Creating your API gateway - Testing your api Content
17. 17 OPEN API GENERATOR
18. 18 OPEN API GENERATOR
19. 19 OpenAPI openapi.yaml visualization compliant code
20. 20 § API first development § Open API § Open API in practice - Creating API compliant code - Integrating with build process - Creating your API gateway - Testing your api Content
21. 21 OPEN API GENERATOR Integrate with your build process bit.ly/31IJZTH
22. 22 OpenAPI openapi.yaml visualization compliant code automate
23. 23 § API first development § Open API § Open API in practice - Creating API compliant code - Integrating with build process - Creating your API gateway - Testing your API Content
24. 24 OPEN API AWS API GATEWAY
25. 25 OPEN API – Infrastructure As Code AWS API GATEWAY CloudFormation Terraform bit.ly/31IJZTH
26. 26 OpenAPI openapi.yaml visualization compliant code automate API Gateway
27. 27 Testing your API Open API § Postman § Testing your response
28. 28 Testing your response Testing your API api.yaml generate request.java response.java
29. 29 OpenAPI openapi.yaml visualization compliant code test postman automate API Gateway
30. 30 § API first development § Open API § Open API in practice - Creating API compliant code - Integrating with build process - Creating your API gateway - Testing your API § Wrapping up Content
31. 31 API FIRST DEVELOPMENT WITH OPEN API § Wait with development until API definition is finished § Little extra documentation can be added in the API specs § Be careful with code generation
32. 32 API FIRST DEVELOPMENT WITH OPEN API § Clear API definition § Teams can work separately § Strong consistency between web layer and API spec § API compliant code § Strong tooling support
33. Thank you && Bye Bye https://nickvanhoof.com bit.ly/31IJZTH https://ordina-jworks.github.io
34. API-first-development with OpenAPI Nick Van Hoof 2019-10-15 @TheNickVanHoof bit.ly/31IJZTH