Open API Beyond Swagger UI

Let's discover the Open API universe beyond Swagger UI: Documentation, API Design, API Design analysis, Code & Test generation, mock, specification import in tools and specification extension.

Transcript

1. Open API Beyond Swagger UI A boundless universe Arnaud Lauret @apihandyman
2. Beyond Swagger UI: Open API Spec
3. Code annotations Swagger UI
4. Expanding Swagger Universe Code Annotations and Swagger UI
5. Swagger Specification
6. January 2016
7. Expanding Swagger OpenAPI Universe Center of Universe: Open API Specification Design Design Analysis Documentation Code & Test Generation Mock Custom tools & Extension Tools’ Import
8. API Design
9. How to describe my API? Write Open API Specification!
10. How to write OpenAPI Spec?
11. Use YAML and Editor
12. READ the Specification!
13. Tools MAY NOT Support whole Specification
14. Demo Swagger Editor https://editor.swagger.io Open API Specification https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md Open API Specification Visual Documentation http://openapi-specification-visual-documentation.apihandyman.io/ Open API Specification Tutorial http://apihandyman.io/writing-openapi-swagger-specification-tutorial-part-1-introduction/
15. API Documentation
16. Many rendering possibilities
17. Interface Contract Is NOT Enough
18. Demo Swagger UI https://github.com/swagger-api/swagger-ui Swagger2markup & Asciidoctor https://github.com/Swagger2Markup/swagger2markup Swagger2Slate & Slate https://github.com/E96/swagger2slate Lucy Console https://github.com/lucybot/lucy-console
19. Open API import
20. Open A Test, API Gateway, Monitoring, Design, Documentation, SDKs ...
21. Demo Postman https://www.getpostman.com/ Ardoq https://ardoq.com/ Runscope https://www.runscope.com/ APIMatic https://www.apimatic.io/
22. API Design Analysis
23. Guidelines respect? Breaking changes?
24. Demo Swagger API Check Style https://github.com/jasonh-n-austin/swagger-api-checkstyle Swagger diff https://github.com/zallek/swagger-diff
25. API Mock
26. MOCK … with a complete Open API Specification!
27. Demo Prism https://stoplight.io/prism/
28. Code & Test Generation
29. OpenAPI = Blueprint
30. Demo Swagger Test Templates https://github.com/apigee-127/swagger-test-templates Swagger Codegen https://github.com/swagger-api/swagger-codegen
31. Custom Tools & Extension
32. Structured File + Extensions = Endless Possibilities
33. Demo Swagger Node https://github.com/swagger-api/swagger-node AWS API Gateway https://aws.amazon.com/
34. A boundless universe
35. It’s up to you to explore this universe! Simple format Many use cases Many existing tools Extensible Easy custom tools
36. Questions?
38. Photo credits Why? by Evan Dennis https://unsplash.com/photos/i--IN3cvEjg OMG RTFM by Cylent https://www.flickr.com/photos/andibits/11227866046/ Warning by M.P.3. https://www.flickr.com/photos/lemonpixel/4578342858/ No Trespassing by Nils https://www.flickr.com/photos/nullprozent/4512766002/ Pier 1 Imports by M. Mozart https://www.flickr.com/photos/jeepersmedia/14677099887/ Microscopes by ZEISS Microscopy https://www.flickr.com/photos/zeissmicro/7039029805/ Easy Way by Memphis CVB https://www.flickr.com/photos/ilovememphis/6784252073/ Star Trek Blueprint by Cardoso https://www.flickr.com/photos/cardoso/2196726835/ Questions? By The Autowitch https://www.flickr.com/photos/autowitch/2198906338 Thank You by Russ Morris https://www.flickr.com/photos/russmorris/2486506322/