API s, Db2 s Native REST Support and z/os Connect

Size: px

Start display at page:

Download "API s, Db2 s Native REST Support and z/os Connect"

Earl Preston
6 years ago
Views:

1 API s, Db2 s Native REST Support and z/os Connect Mark Turner Royal Bank of Scotland 07/11/2017 Session IC

2 Agenda What is REST Db2 Native REST support Installing Db2 REST Creating, Running & Dropping Services zos Connect Introduction

3 What is REST? REpresentational State Transfer An architectural style often used in the development of web services More lightweight than SOAP (Simple Object Access Protocol) Stateless A single unit of recovery Essentially the architecture of the internet Responses returned as JSON

4 Why use REST? Quick time to market Reuse existing assets and services Relatively easy to program Opens up new markets The API Economy

5 The API Economy Bank APIs Mortgages Loans Acct Enquiry etc Car Dealer Finance Comparison Site Estate Agent One Stop Banking App

6 What is the Db2 REST API Implements HTTP protocol as part of DDF App Server / Client ODBC / JDBC / CLI REST Client HTTP(s) Db2 for z/os DDF DRDA HTTP(s) Executes a single SQL statement SELECT, INSERT, UPDATE, or DELETE CALL proc Executes as static SQL Does not require Db2 Connect driver or license

7 REST Overview POST /account/deposit { account : , amount : } Update Account SP REST Client Response { deposit : successful } GET /account/balance REST Listener (Db2) { account : , } Account Enquiry SP Response { account : , balance : }

8 Db2 REST Limitations IDAA access is not supported Restriction will be lifted in the future Remote DRDA requests are not supported Restriction may be addressed in the future DB2 System profile monitoring is not supported Restriction will be lifted in the future

9 Installing Db2 REST

10 Db2 Support for REST Information APAR II14827 Lists limitations and APARs that lift those restrictions Db2 V11 PI66828 Base REST delivery PI70477 Removes message size limitations PI80087 Client Certificate and Trusted Context support PI81224 Fixes zero length input parm abend PI86867 Multiple improvements Db2 V12 PI70652 Base delivery PI80088 Client Certificate and Trusted Context support PI81225 Fixes zero length input parm abend PI86868 Multiple improvements

11 Enabling Db2 Support Create new DSNR profile RDEF DSNR (ssid.rest) UACC(NONE) PERMIT ssid.rest CLASS(DSNR) ID(DB2USER) ACCESS(READ) Create new catalog table SYSIBM.DSNSERVICE DB2.SDSNSAMP(DSNTIJRS) Consider enabling Db2 TLS/SSL support Uses SECPORT

12 Verifying Installation Using Web Browser, or a REST client: { "DB2Services": [ { "ServiceName": "DB2ServiceDiscover", "ServiceCollectionID": null, "ServiceDescription": "DB2 service to list all available services.", "ServiceProvider": "db2service-1.0", "ServiceURL": " }, { "ServiceName": "DB2ServiceManager", "ServiceCollectionID": null, "ServiceDescription": "DB2 service to create, drop, or alter a user defined service.", "ServiceProvider": "db2service-1.0", "ServiceURL": " } ]} Note: Internet Explorer treats JSON as a file to be downloaded.

13 Creating a Db2 REST Service A Db2 REST Service = Stored Procedure Single SQL statement Data Studio does NOT support creating Db2 REST services Use a REST client to invoke Db2 System service DB2ServiceManager Browser REST plugin Desktop client Roll your own (see article by Triton s DB2 Dinosaur, James Gill, for a php example)

14 Security Requirements READ access to DSNR ssid.rest BINDADD PACKADM on the service collection

15 Db2 REST Test Case Uses Db2 Sample database DEPT and EMPLOYEE tables Create Stored Procedure to list all Employees for a specified department Expose Stored Procedure as a REST service

16 Test Case Stored Procedure

17 Creating a Db2 REST Service URI Header POST Accept: application/json Content-Type: application/json JSON Body { "requesttype": "createservice", "sqlstmt": "<sqlstatement>", "collectionid": "<servicecollectionid>", "servicename": "<servicename>", "description": "<servicedescription>", "<bindoption>": "<bindoption>" }

18 Creating a Db2 REST Service Request

19 Creating a Db2 REST Service Response

20 What gets Created? DB2 Package LOCATION COLLID NAME CONTOKEN Sample GetEmployees HTTPREST SQL in Package -- SQL statements in PACKAGE : Sample.GetEmployees.() call GETEMPLOYEES (:dept, :errmsg) SYSIBM.DSNSERVICE NAME COLLID CONTOKEN ENABLED GetEmployees Sample HTTPREST Y

21 List REST Services GET { "DB2Services": [ {"ServiceName": "DB2ServiceDiscover", "ServiceCollectionID": null, "ServiceDescription": "DB2 service to list all available services.", "ServiceProvider": "db2service-1.0", "ServiceURL": " }, {"ServiceName": "DB2ServiceManager", "ServiceCollectionID": null, "ServiceDescription": "DB2 service to create, drop, or alter a user defined service.", "ServiceProvider": "db2service-1.0", "ServiceURL": " }, {"ServiceName": "GetEmployees", "ServiceCollectionID": "Sample", "ServiceDescription": "List Employee names that work for a given department", "ServiceProvider": "db2service-1.0", "ServiceURL": } ] }

22 List Service Requirements GET Request Schema

23 List Service Requirements Response Schema Parameters Description

24 List Service Requirements Response Schema Results Set Description

25 Run the Service POST

26 Run Service Response Run the Service

27 Drop a Service URI POST Header Accept: application/json Content-Type: application/json JSON Body { "requesttype": dropservice", "collectionid": "<servicecollectionid>", "servicename": "<servicename>" }

28 Drop a Service

29 Why use an API Gateway? Db2 only supports POST and GET PUT and DELETE not supported Provide a single service/service discovery gateway for z/os Other services may exist e.g. CICS, IMS, Batch etc Consistent auditing, logging and authorisation Expose Services as one or more APIs

30 Services vs APIs Services POST /accounts/create + JSON with account create info POST /accounts/balance + JSON with account number POST /accounts/update + JSON account number and credit/debit amount REST interface is limited and may fall short of what developers require/expect APIs POST /accounts?name=john + JSON with John s info GET /accounts?number=1234 PUT /accounts?number= JSON with credit/debit amount HTTP verb conveys method against the resource URI conveys resource being acted upon JSON body contains specific data for the action & resource More aligned with developers requirements/expectations

31 z/os Connect Architecture z/os Connect API Editor REST Client Liberty Profile z/os Runtime z/os Connect EE 3 Interceptors Data Transform 5 Service Providers 6 CICS DB2 IMS MQ Discovery Audit Logging Authorisation 1 zos Connect is a servlet that runs in Liberty Profile 3 Interceptors are callout points to invoke common services authorisation,logging etc 5 Service providers provide the connectivity to the backend systems 2 zos Connect accepts REST URIs and JSON data 4 Data transformation translates client requests to format expected by backend 6 Backend systems supported by zos Connect

32 Creating a z/os Connect Service REST Client 5. Invoke API POST GET PUT DELETE Liberty Profile for z/os API Mapping/ Transform z/os Connect EE 3. Deploy API Interceptors Service Providers CICS DB2 IMS MQ 4. Discover API 2. Create API 1. Create Service Archive Swagger 2.0 Description z/os Connect API Editor

33 Thank You

uk/2017/feedback/ic Paper feedback forms

34 Session feedback Please submit your feedback online at: Paper feedback forms also available from the Chair person This session is IC

DB2 REST API and z/os Connect SQL/Stored Procedures Play a Role in Mobile and API Economics

DB2 REST API and z/os Connect SQL/Stored Procedures Play a Role in Mobile and API Economics Maryela Weihrauch IBM Distinguished Engineer z Systems Analytics WW Technical Sales and Client Champion Please