Download as PDF, PPTX
![Restructured handlers
DIY
:for-‐roles
[:admin
:user]](https://image.slidesharecdn.com/schemaandswaggereuroclojure2014-140627031114-phpapp02/85/Euroclojure2014-Schema-Swagger-making-your-Clojure-web-APIs-more-awesome-51-320.jpg)
Uploaded byMetosin Oy
Euroclojure2014: Schema & Swagger - making your Clojure web APIs more awesome
- The document discusses using Prismatic Schema and Swagger to describe, validate, and document Clojure web APIs. It covers topics like Schema validation and coercion, Ring-Swagger, Compojure-API, and Fnhouse-Swagger integration. - Ring-Swagger implements the Swagger specification for Ring and uses Schema for data models and coercion. Compojure-API is an extendable web API library that uses Schema and generates Swagger documentation. Fnhouse-Swagger provides Swagger support for the Fnhouse library. - The document encourages adopting Schema and Swagger tools to build robust and well-documented Clojure web APIs in a consistent manner across different frameworks.
More Related Content
Similar to Euroclojure2014: Schema & Swagger - making your Clojure web APIs more awesome
![5G Explained! A High Level Overview [Introduction]](https://cdn.slidesharecdn.com/ss_thumbnails/5gexplainedahighleveloverview-260119165306-cc137a3e-thumbnail.jpg?width=640&height=640&fit=bounds)
Euroclojure2014: Schema & Swagger - making your Clojure web APIs more awesome
- 1. Schema & Swagger makingyour Clojure web APIs more awesome EuroClojure 2014 Tommi Reiman @ikitommi
- 2. Topics • (Too) simpleweb api in Clojure • Prismatic Schema • Swagger • Ring-swagger • Compojure-api • Fnhouse-swagger • Wrapup
- 3. (Too) simple webapi in Clojure D git clone h,ps://github.com/ikitommi/euroclojure2014.git
- 4. The sausage • Id • Name • (Length) • (Description) • Origin – Country – (City) h,p://www.sweetpoland.com/
- 5. How do Iprogram with sausages?
- 6.
- 7.
- 8.
- 9. Clojure Sausage? A Schema is a Clojure(Script) data structure describing a data shape, which can be used to document and validate func=ons and data. h,ps://github.com/prismaAc/schema
- 10.
- 11.
- 12.
- 13. Bydgoszcz Tampere h,p://en.wikipedia.org/wiki/Bydgoszcz h,p://kuvat2.huuto.net/f/4f/1cdb0858b03c69122e9c06f9554a2-‐orig.jpg
- 14.
- 15.
- 16.
- 17. perf “For now our pragmaAc soluAon is to only turn on validaAon at key boundaries in producAon code (using :always-‐validate), and only check the remaining asserAons in tests. In pracAce this seems to catch nearly all the issues, without causing any performance problems.” -‐ Jason Wolfe
- 18.
- 19. Sc goodies • Doubleschema • Schema selectors • Generative Schema • Schema-tools • Contribs • Ring-Swagger
- 20.
- 21.
- 22. Sc goodies h,ps://gist.github.com/davegolland/3bc4277fe109e7b11770 GeneraAve Schema
- 23.
- 24. Sc goodies h,ps://github.com/sfx/schema-‐contrib Contribs h,ps://github.com/cddr/integrity
- 25. Sc goodies h,ps://github.com/metosin/ring-‐swagger Ring-‐Swagger
- 26.
- 27. Swagger • a specificationand complete framework implementation for describing, producing, consuming, and visualizing RESTful web services – https://helloreverb.com/developers/swagger • Existing adapters for most common web stacks • Clojure Libs – Octohipster (https://github.com/myfreeweb/octohipster) – Swag (https://github.com/narkisr/swag) – Ring-Swagger • Compojure-Api (https://github.com/metosin/compojure-api) • Fnhouse-swagger (https://github.com/metosin/fnhouse-swagger)
- 28.
- 29.
- 30.
- 31.
- 32.
- 33. Code-gen • Client generators – Scala, Flash, Java, Objc, PHP, Python, Python3, Ruby • Javascript via swagger-js • Also server-stub generators … no clojure-support yet (anyone?)
- 34.
- 35.
- 36.
- 37.
- 38. Ring-Swagger • Swagger implementationfor Ring – https://github.com/metosin/ring-swagger – Based on Schema for data models coercion • Extendable mappings of Schemas to JSON Schemas • Symmetric parsers for common types (inc. Dates, DateTimes) • Add-ons (coercers, predicates, tools) – Provides Swagger spec endpoints as Ring routes • Resource-listing,Api-declarations, Swagger-UI – Independent to routing-libs • Currently bindings exist to Compojure-Api and fnHouse
- 39.
- 40.
- 41.
- 42.
- 43. Ring-Swagger ... should be easier to extend.
- 44. Ring-Swagger-UI • Jar-packaged versionof the Swagger-ui – https://github.com/metosin/ring-swagger-ui
- 45. So, where ismy Sausage API?
- 46.
- 47. Compojure-Api • An extendableweb api lib on top of Compojure – https://github.com/metosin/compojure-api – Macros middlewares with good defaults – Schema-based models coercion – Swagger docs
- 48.
- 49.
- 50.
- 51. Restructured handlers DIY :for-‐roles [:admin :user]
- 52.
- 53. Sausage API, takeone ? D
- 54. • Macro-fu toreverse-engineer the route tree at macro-expansion time – No runtime penalty – Static routes (no ad-hoc hypermedia) • Storing compiled route tree in 1) Evil Mutable State, part1: globally side-effecting macro 2) Evil Mutable State, part2: macro-filled global atom 3) Current: Namespace cluttering localVar 4) Next up: DynamicVar? Route Resolution
- 55.
- 56.
- 57.
- 58.
- 59.
- 60.
- 61. fnhouse • Fnhouse isa library that builds on top of ring to provide a concise way to write web handlers safely, readably, without global variables, without repeating yourself, and with hooks to do much more. • https://github.com/Prismatic/ fnhouse
- 62. fnhouse • Defnks withmetadata è annotated handler – Builds on schema plumbing • Bootstrap: collect defnks wrap to ring- handlers • No global state
- 63.
- 64. fnhouse-swagger • https://github.com/metosin/fnhouse-swagger • fnhouse.swagger(54 loc) • bootstrap it:
- 65.
- 66. Schema Swagger • Prismatic Schema is an awesome tool – Describe, validate coerce your data • Swagger to publish out api descriptions • Building on top of ring-swagger: – Compojure-api è declarative web apis – Fnhouse-swagger è meta-data done right – YourFavouriteWebLib è just do it ( poke us).
- 67. Next things @Metosin • Ring-Swagger – Make feature complete (+Swagger 2.0) • Compojure-Api – Cleanup route-peeling – Ring-middleware-format – Repl-tools? • Help others to adapt • kekkonen.io – CQRS-lib
- 68.