Bridging multiple API description languages with Restlet

12
BRIDGING MULTIPLE API DESCRIPTION FORMATS WITH RESTLET FRAMEWORK Leading Web API Framework for Java http://restlet.com May 20, 2014 Jérôme LOUVEL [email protected]

description

Presentation for API Strategy & Practice workshop at Gluecon 2014 in Boulder, Colorado. 1) Code your web API in Java language 2) Document your web API in Java language 3) Don't get locked in 4) Demo of Restlet Framework + APISpark 5) Restlet Platform, what we are working on! 6) Restlet Framework, web API framework for Java 7) Keep in touch

Transcript of Bridging multiple API description languages with Restlet

Page 1: Bridging multiple API description languages with Restlet

BRIDGING MULTIPLE API DESCRIPTION FORMATSWITH RESTLET FRAMEWORK

Leading Web API Framework for Java

http://restlet.com

May 20, 2014

Jérôme [email protected]

Page 2: Bridging multiple API description languages with Restlet

CODE YOUR WEB APIIN JAVA LANGUAGE

JAX-RS API

Restlet API

Spring RESTSwagger

annotations

Bean Validationannotations

Google Cloud Endpoints API

1. Select

a main

Java API

Javasourcecode

3. Write your

Java code

JAXBannotations

2. Add extra

annotation

APIs

Jackson annotations

RESTfulWeb API

4. Get your

web API

Page 3: Bridging multiple API description languages with Restlet

DOCUMENT YOUR WEB APIIN JAVA LANGUAGE

RESTfulWeb API

Web API definition

1. Code your

web API

(iterate)

3. Introspect

source code

2. Select

target API

specs

4. Complete

API definition

manually

Swagger

APIBlueprint

RAML

Google APIDiscovery

WADL

Intro-spector

Page 4: Bridging multiple API description languages with Restlet

DON’T GET LOCKED-INAPI DEFINITION PORTABILITY & COPYRIGHT

– No clear winner at this stage

translate your API definition between various languages

use the best of each language ecosystem (tooling, directory)

– Take API copyright seriously (now)

play nice in the API economy: open your API definition– select a Creative Commons or Open Source license

– publish to the « API Commons »

verify the legal terms of the APIs you depend on

Page 5: Bridging multiple API description languages with Restlet

LAUNCH INTROSPECTOR TOOLSUPPORTS RESTLET API, NEW JAVA APIS COMING

1) Launch fromyour IDE or the command line

2) Web API definition pushed

to APISpark

Page 6: Bridging multiple API description languages with Restlet

DISPLAY YOUR WEB API DOCRELAUNCH INTROSPECTOR TO KEEP IN SYNC

Page 7: Bridging multiple API description languages with Restlet

CHECK OUT API COMMONS TABWEB API MANIFEST BASED ON SWAGGER

Page 8: Bridging multiple API description languages with Restlet
Page 9: Bridging multiple API description languages with Restlet

CHECK OUT THE HOSTED SWAGGER UIEMBEDDED IN YOUR WEB SITE

Page 10: Bridging multiple API description languages with Restlet

RESTLET PLATFORMWHAT WE ARE WORKING ON !

Restlet Framework (open source)– introspect all main Java APIs

– import & export main API languages

– generate Client SDKs, Server skeletons & HTML

APISpark (full stack PaaS)– complete integration of Swagger tool chain

– embed additional tool chains

– GitHub synchronization

Page 11: Bridging multiple API description languages with Restlet

WEB API FRAMEWORK

FOR JAVA DEVELOPERS

6 editions44 extensions

1,5 M downloads100 000 developers

Version 2.2.0 launched in March 2014

Covers our ROA/DAPI guidelines

Consistent client & server APIPowerful routing & filtering

Comprehensive web securityAligned with REST & HTTP

Fast & scalable

Page 12: Bridging multiple API description languages with Restlet

KEEP IN TOUCH!

http://restlet.com

Twitter: @jlouvel

[email protected]

Restlet Platform

PaaS and Web API integrationInterview with Daniel Jacobson (Netflix)