making restful web services the easy way with node · pdf filetitle: making restful web...

Copyright©2017, Oracleand/oritsaffiliates.Allrightsreserved.|

MakingRESTfulWebServicestheEasyWaywithNode.js

DanMcGhanOracleDeveloperAdvocateOctober3,2017


🎉💃🍻😃👍🕺🎉

Confidential– OracleInternal/Restricted/HighlyRestricted 3

Getexcitedfor…


🎉💃🍻😃👍🕺🎉JavaScriptin theDatabase!!!

Confidential– OracleInternal/Restricted/HighlyRestricted 4

Getexcitedfor…


JavaScriptintheDatabase!!!• NewMulti-LanguageEnginefromOracleLabs• NowavailableforpreviewonOTN– ViaaVirtualBoxVM

• GototheirtalkWednesdayat5:30pm– CON6744:AcceleratingYourDatabaseApplicationsSimplywithGraal–MarriottMarquis(YerbaBuenaLevel)– Salon13– Ignorethedescriptioninthesessionbuilder

5


SafeHarborStatementThefollowingisintendedtooutlineourgeneralproductdirection.Itisintendedforinformationpurposesonly,andmaynotbeincorporatedintoanycontract.Itisnotacommitmenttodeliveranymaterial,code,orfunctionality,andshouldnotberelieduponinmakingpurchasingdecisions.Thedevelopment,release,andtimingofanyfeaturesorfunctionalitydescribedforOracle’sproductsremainsatthesolediscretionofOracle.

6


Aboutme• DanMcGhan–OracleDeveloperAdvocate– FocusonJavaScriptandOracleDatabase

• ContactInfo– [email protected]–@dmcghan– jsao.io

7


Agenda

RoughintrotoAPIsandNode.js

ManualAPIcreation

APIcreationwithSails.js

APIcreationwithORDS

1

2

3

8

4


Agenda

RoughintrotoAPIsandNode.js

ManualAPIcreation


APIcreationwithORDS

1

2

3

9

4


What’sREST?• REpresentation StateTransfer– Architecturalstylefordistributedhypermediasystems–OriginallydefinedinRoyFielding’sdoctoraldissertation

• Definessixconstraints

–Mostimplementationsdon’tcomply100%

10

UniformInterface Stateless Cacheable

Client-server LayeredSystem Codeondemand


Clientcommunicatesintentvia• URLpathsbasedonnouns,notverbs

• HTTPmethods

11

Type Example

Collection http://server.com/api/employees

Resource http://server.com/api/employees/101

Method CRUD/DatabaseAction

POST Create/INSERT

GET Read/SELECT

PUT Update/UPDATE

DELETE Delete/DELETE


WhatisNode.js?• Server-sideJavaScriptruntime–Onelanguage,front-endandback-end

• JavaScriptruntimebuiltonChrome’sV8JavaScriptengine– ThoughV8isbeingdecoupledtoallowforotherJavaScriptengines

• Packageecosystem(NPM)isworld’slargestrepoofopen-sourcelibraries• Lightweightandefficient:event-driven,non-blockingI/Omodel

12

Copyright©2017, Oracleand/oritsaffiliates.Allrightsreserved.| 13

Node.js architecture


Rollyourownoruseaframework?

14

Rollyourown• Morecode

• Moreflexibility

• Lowershort-termlearningcurve

• Lowerlong-termproductivity

Framework• Lesscode

• Lessflexibility

• Highershort-termlearningcurve

• Higherlong-termproductivity


Whatfeaturesdoyouneedtosupport?• Pagination,sorting,&filtering• Authentication&authorization• Caching/ETag• Doc/Swagger• Real-timepush/WebSockets• Throttling• Multiplerepresentations(JSON,XML,CSV)• CORS

15


BasicingredientsforaRESTAPI

Client Middle-tier Database




WebServer

acceptHTTPrequests,sendHTTPresponses




WebServer

RoutingLogic

identifyintent,routerequesttocorrectcontrollerlogic




WebServer

RoutingLogic

ControllerLogic

extractdata,applybusiness&databaselogic,generateresponse




WebServer

RoutingLogic

ControllerLogic

DatabaseLogic

applybusinesslogic,updatepersistedstate


Howshouldthisbedone?Youdecide!


WebServer

RoutingLogic

ControllerLogic

DatabaseLogic


Agenda

RoughintrotoAPIs andNode.js

ManualAPIcreation


APIcreationwithORDS

1

2

3

22

4


Webserveroptions• Express– Highlypopular,generalpurposewebserver

• Restify–WebserverfocusedonAPIs,addsDTrace support

• Kracken– fromPayPal,layeroverExpress,addsstructureandconvention

• Hapi– fromWalmart,alternativetoExpress– Includesmodulesforvalidation,CORS,sessions,caching,logging,etc.

23


Databaselogicoptions• Drivers– Lowlevel,butextremelyflexible–Mayrequirespecificdatabaseknowledge

• ORMs– Higherlevel,canbemoreproductive– Attempttoabstractawaythedatabase

24


node-oracledbclassoverview

25

Baseclass• Getconnectionsorcreatepools• Setconfigurationparameters

ConnectionPooling• Dramaticallyincreasesperformance• Built-inpoolcacheforconvenience

SQLandPL/SQLExecution• Transactionsupportw/datatypeconversion• BindusingJavaScriptobjectsorarrays

Read-consistent,pageable cursor• Usedforlargeresultsets• RecursivecallbacksorNode.jsstreams

Largeobjectsupport• CanfetchsmallerLOBsasstring/buffer• StreamlargeLOBswiththisclass

Oracledb

Pool

Connection

ResultSet

Lob


Abasicdirectorystructure

26



27

Name,description,dependencies,scripts



28


Mainfile,startstheapplication



29



Genericdirectoryforreusablelogic



30




Directoryforcontrollerlogic



31




Directoryfordatabaselogic




32




Directoryfordatabaselogic


Directoryforapplicationconfiguration


ManualAPIDemo

33


ManualAPIreview• HavetomanuallyimplementCRUDfunctionality– Notsobadifyou’recomfortablewithSQL(couldevenbescripted)– Couldbeadvantageousforcomplextasks(multipletables,transactions,etc.)

• GETrequestscanbetough– Paginationnotsobad,butapaintorepeat– NogenericsolutionforconvertingJSobjectstowhereclauses– NogenericsolutionforconvertingJSobjectstoorderbyclauses

34


Agenda


ManualAPIcreation


APIcreationwithORDS

1

2

3

35

4


MVCandAPIFrameworks• Frameworksofferall-in-onesolutions– Includewebservers– Generaterouting,controller,andmodellogic–Manyotherfeatures,varybytheframework

• Favorconventionoverconfiguration

36


Sails.js andLoopback• Sails– AnMVCframeworkforNode.js• UsesWaterlineORMfordatabasemodeling

– Favoritefeatures• Blueprints:easilyprototypeAPIs• WebSocket integration

• Loopback– AnAPIframeworkforNode.js• UsesacustomORMfordatabasemodeling

– Favoritefeature• DiscoveryAPIsforOracleandothers

37


GettingstartedwithSails.js• Installation– npm install sails -g

• Createanapplication– sails new my-project

• Startuptheapplication– cd my-project– sails lift

• AddingtheOracleadapterforWaterline– npm install sails-oracle-db --save

38


SailsAPIDemo

39


SailsAPIreview• Sailsbringsout-of-the-boxconventiontoeachproject• Initiallearningcurvecanbealittlesteep– Butsubsequentusegetsbetter

• BlueprintscanhelpwithAPIprototyping

40


UsecautionwithORMs• Someenforcecasesensitivity

– Apainwhenyouwanttorunad-hocqueries

• Somedon’tusebindvariables– Forcesfrequenthardparses– Loopbackwins

• Somedon’tsupporttransactions

41

selectcolumnfromuser

select"column"from"user"becomes


Agenda


ManualAPIcreation


APIcreationwithORDS

1

2

3

42

4


IntroducingOracleRESTDataServices(ORDS)• Providesdataaccessconsistentwithmodernapp-dev frameworks–Mid-tierapplication– CanmapRESTfulrequeststoSQL– CanreturnresultsinJSONformat• JavaScriptfriendly

• Services– HTTP(s)relationaldataaccess–OracleJSONcollectionbasedschemalessaccess–OracleNoSQL accessoverHTTP–OracleAPEXmid-tier,webtoolkitapps,mod_plsql replacement


ORDSreleasehistory

Version Date Description

1.0 2010 FirstreleaseasOracleAPEXListenerwithwith supportforOWAtoolkitusedbyAPEX

1.1 2011 First releasewithRESTsupportforJSON,Microdata,CSV,Pagination.AlsoaddedFOP

2.0 2012 OAuth2support,IntegratedwithAPEX, MultiDatabase,SQLDeveloperintegration

2.0.5 2013 AddedPDBsupport

2.0.6 2014 RenamedtoOracle RESTDataServicestoemphasizeRESTcommitment

2.0.8 2014 AddedRESTFiltering

3.0 2016 RESTAutoTable,NoSQL,DB12 JSON,BulkloadingoverREST


ServingJSONresultsfromrelationaldata

OracleDatabase

URI

HTTP(S)client

OracleRESTDataServices

MapandBind SQL

Transform SQLResultSetTransformtoJSONJSON

• Datastoredinstandardrelationaltablesandcolumns• ORDSdeveloperdefinesURI=>SQLmapping• AppdevelopercallsnamedURIoverHTTP(S)–WorksforJavaScript(Node.js),Java,Python,PHP,Ruby,etc.


ORDSAPIDemo

46


ORDSreview• ORDScangreatlysimplifyAPIcreationonOracleDatabase– AutoREST fortables– Built-insupport forpagination,filtering,even“asof”

• HasabuiltinOAuthServer• CanuseORDSincombinationwithNode.js– HideORDSbehindafirewall– ProxyselectrequestsfromNode.js toORDS(useauthenticationforNode.js server)– Lookatnode4ords foranexample

47


Summary• There’snoperfectsolutionforcreatingRESTAPIswithNode.js• ManualAPIimplementationsprovidethemostcontrol– Butalsorequirethemostknowledgeandcode– I’dliketoseealayer overthedriverforwhere,order,limit,andoffset

• ORMsprovideabstractionsfordatabases– Butmaynotusethedatabase“correctly”

• APIframeworksprovideconvention– Butonlymakesenseifyouagreewiththoseconventions

48


• Express

• Restify

• Hapi

• Kracken

• Driver• node-oracledb

– Query/SchemaBuilder• Knex

– ORMs• Sequelize

• Bookshelf

• Waterline

49

• Sails

• Loopback

• ORDS

Nextsteps:learnandcode!WebServers DriversandORMs Frameworks

making restful web services the easy way with node · pdf filetitle: making restful web...

Documents