Download as PDF, PPTX
Uploaded byTony Tam
Fastest to Mobile with Scalatra + Swagger
The document discusses the integration of Swagger with Scalatra to create efficient, machine-readable API documentation. It emphasizes the importance of clear contracts between consumers and services, arguing that Swagger simplifies this process and enables discoverable APIs. Additionally, it highlights the benefits of Scalatra as a lightweight framework that supports Swagger, allowing for auto-generation of documentation without the need for extensive annotations.
More Related Content
Similar to Fastest to Mobile with Scalatra + Swagger
Fastest to Mobile with Scalatra + Swagger
- 1. Fastest to Mobile! WithScalatra + Swagger! ! @fehguy!
- 2.
- 3. Swagger Philosophy! Service documentationsucks! ! typically(
- 4. Swagger Philosophy! • Communicatingis too much work! – Users don’t want to write YOUR SDK! – If you’re good at Ruby, you suck at GO! • Consumers need a contract! – Service logic doesn’t belong in the SDK! • Services are plumbing! – We shouldn’t all be plumbers! – Business logic is your business!
- 5. Swagger Philosophy! • Solvedby machine-readable, discoverable API contract! • Should speed up, not slow down development process! • External services/proxies not required!
- 6. What is Swagger?! • An interface to your service! – Described in JSON! • It is a contract to your service! • Enables “bigotry-free” restful design with emphasis on getting things done! – Many ways to delete a Pet!
- 7. How does itwork?! • Discoverable at runtime, not compile-time! • It’s just JSON! • No server integration required! – You can describe an API that’s not even yours! – Deploy anywhere! Put it on github!! – Swagger is JUST a way to describe an API!
- 8. But Why?! • Machine-readablecontract! – Description of *everything* the server can do! – Server-controlled documentation! – Server/language/platform/deployment agnostic! • Documentation, code generation, client generation! – Like Headers for C, Interfaces for Java!
- 9. How do youadd Swagger?! • Static Files! – Manually crafted JSON! • Heuristics! – Traffic inspection! • Code inspection! – Code comments, static annotations! • Runtime generation! It’s just JSON!!
- 10. Swagger + Scalatra! • Scalatra is a Lightweight, High- performance Micro web framework! • Extremely clean DSL! • First-class swagger support! • http://www.scalatra.org!
- 11. Scalatra as aREST API!
- 12. Scalatra as aREST API! Content&Type& Nego,a,on&via& json4s&
- 13. Scalatra as aREST API! Content&Type& Nego,a,on&via& json4s& Simple&Rou,ng&
- 14. Scalatra as aREST API! Content&Type& Nego,a,on&via& json4s& Simple&Rou,ng& Param& Extrac,on&
- 15. Scalatra as aREST API!
- 16. Swagger + Scalatra! • Without Swagger Support! • With Swagger Support!
- 17. Swagger + Scalatra! • Auto- generation of swagger JSON!!
- 18. Swagger + Scalatra! • No ugly Java annotations!!
- 19. Swagger + Scalatra! • Model descriptions!
- 20. Swagger + Scalatra! • Model descriptions! Type&safety& has&its& benefits!&
- 21. Swagger UI for“free”!
- 22. Swagger UI for“free”! Your&Boss& can&try&your& API!&
- 23. Going Moble! • Ifyou are good at scala, you probably suck at Objective C!
- 24. Swagger + Mustache! • Typesafe conversion between swagger to Objective C!
- 25. Swagger + Mustache! • Typesafe conversion between swagger to Objective C! Templates& you&can& Tweak!&
- 26.
- 27.
- 28.
- 29. Other Mobile SDKs! • Android + Java!
- 30. Other Mobile SDKs! • Android + Java!
- 31. Other Mobile SDKs! • Javascript!
- 32. Scalatra + Swagger! • Simplest DSL for REST APIs in Scala! • Minimal dependencies! • Tested at scale! • Not “hello world”! • Apache 2.0 everything!
- 33.