Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Speaker Deck
PRO
Sign in
Sign up for free
Introduction to Basejump
Ryan Paul
March 14, 2016
Programming
1
1.1k
Introduction to Basejump
Build REST APIs on RethinkDB without writing code
Ryan Paul
March 14, 2016
Tweet
Share
More Decks by Ryan Paul
See All by Ryan Paul
Using Async Iterators in Node.js
segphault
0
770
Realtime data visualization with RethinkDB and Epoch
segphault
1
590
Realtime web apps with RethinkDB and full-stack Ruby
segphault
2
280
Jupyter and RethinkDB
segphault
1
500
Using RethinkDB with Tornado & EventMachine
segphault
0
500
RethinkDB Training Course
segphault
3
370
RethinkDB Cluster Monitoring
segphault
0
470
Composing frontend Web applications with MontageJS
segphault
4
1.1k
Intro to MontageJS
segphault
1
170
Other Decks in Programming
See All in Programming
Qiita Night PHP 2023
fuwasegu
0
11k
Gradle build: The time is now
nonews
1
490
Refactor with using `available` and `deprecated`
417_72ki
3
380
ECS Service Connectでマイクロサービスを繋いでみた
xblood
0
720
Hatena Engineer Seminar #23「新卒研修で気軽に『ありがとう』を伝え合える Slack アプリを開発した話」
slashnephy
0
360
Listかもしれない
irof
1
280
新卒でサービス立ち上げから Hasuraを使って3年経った振り返り
yutorin
0
230
存在しないアセットへの参照と 未公開アセットでのネタバレに どう立ち向かうか / How to prevent missing assets and spoilers by assets
orgachem
0
160
Functional Data Engineering - A Blueprint for adopting functional principles in data pipeline
vananth22
0
190
データドリブンな組織の不正検知
fkubota
0
280
Spring BootとKubernetesで実現する今どきのDevOps入門
xblood
0
390
Prácticas de Seguridad en Kubernetes
pablokbs
0
130
Featured
See All Featured
Build The Right Thing And Hit Your Dates
maggiecrowley
22
1.4k
Easily Structure & Communicate Ideas using Wireframe
afnizarnur
182
15k
Raft: Consensus for Rubyists
vanstee
130
5.7k
Designing on Purpose - Digital PM Summit 2013
jponch
108
5.9k
Learning to Love Humans: Emotional Interface Design
aarron
263
38k
Code Reviewing Like a Champion
maltzj
508
38k
GraphQLとの向き合い方2022年版
quramy
20
9.9k
Three Pipe Problems
jasonvnalue
89
8.9k
Rails Girls Zürich Keynote
gr2m
87
12k
StorybookのUI Testing Handbookを読んだ
zakiyama
8
3.2k
Scaling GitHub
holman
453
140k
The Power of CSS Pseudo Elements
geoffreycrofte
52
4.3k
Transcript
Basejump Build a REST API on RethinkDB
Ryan Paul RethinkDB Evangelist @segphault
API Anatomy Dissecting an API backend
API Anatomy • Server to parse & handle requests •
Routing to manage endpoints • Validation to sanitize user input • Persistence to store & retrieve data
API Anatomy RethinkDB NodeJS JOI Koa Vue Browser REST API
Koa Router W3C Fetch Real-world RethinkDB stack
API Anatomy Persistence Runtime Validation Server Frontend Framework Browser REST
API Router REST Client Real-world RethinkDB stack
API Anatomy • Lots of layers between persistence and requests
• More boilerplate than business logic • Repetitive code that is difficult to reuse
API Anatomy router.post("/api/event/:id/messages", function*(id) { this.checkBody("message").notEmpty(); if (this.errors) this.throw(400, {success:
false, errors: this.errors}); yield r.table("messages").insert({ created: r.now(), text: this.request.body.message, sender: sender, event: id}); this.body = {success: true}; });
Can we abstract away the boilerplate?
Project Basejump Attach queries to endpoints
Basejump • Visual tool for prototyping API backends • Dynamic
routing middleware for attaching queries to endpoints • Powered by declarative JSON description format
Basejump
{A} 1ST
Basejump Router • Database agnostic routing middleware • Uses Node’s
VM module to execute code • Integrates seamlessly with Koa and Socket.io • Swagger-based format to describe routes and actions
Swagger
Swagger • Standard format for describing APIs — can use
YAML or JSON • Uses JSON Schema for validation • Supported by many tools & frameworks • Extensible via vendor properties
Swagger paths: /test: get: parameters: - {in: query, name: count,
type: number} x-action: > r.table("test") .orderBy(r.desc("time")) .limit(params.count) post: parameters: - in: body name: body schema: $ref: "#/definitions/test" x-action: > r.table("test").insert(params.body)
Embed Basejump • Embed in your own Node app •
Pass custom objects into the execution context • Inherit and override the request handler • Custom pre & post processing on input and output
Embed Basejump const app = require("koa")(); const router = require("basejump-router");
const r = require("rethinkdbdash")(); app.use(require("kcors")()); app.use(require("koa-bodyparser")()); app.use(router.middleware.koa({ swagger: "routes.yaml", context: {r: r} })); app.listen(8000);
Project Basejump Status & Future Plans
Basejump • Not ready for adoption quite yet • API
and data format still subject to change • New features might necessitate additional format churn
Feature Roadmap • Support for embedding in Express • Interactive
Schema editing • Pluggable view system • Route collections and blueprints • Authentication and user management • Live API debugging
Feature Ideas • Generate client libraries for mobile & web
• Use schemas to generate input forms & data dashboard • Support for file uploads & multipart mime • Automatically generate tables and indexes from schemas
How does it compare to Fusion?
How does it compare to Fusion? Horizon?
Basejump vs Horizon • Basejump: backend-first development & REST APIs
• Horizon: frontend-first development & WebSockets
Basejump & Horizon • Embed Basejump and Horizon middleware in
the same Node app • Expose Basejump routes through Horizon custom endpoint • Converge authentication and schema validation?
• RethinkDB website: http://rethinkdb.com • Basejump Router: http://github.com/segphault/ basejump-router •
Follow me on Twitter: @segphault Resources