RPG & PHP REST SERVICES WITH APIGILITY. Chuk Shirley Sabel Steel Service Club Seiden

Size: px

Start display at page:

Download "RPG & PHP REST SERVICES WITH APIGILITY. Chuk Shirley Sabel Steel Service Club Seiden"

Bennett Webb
5 years ago
Views:

1 RPG & PHP REST SERVICES WITH APIGILITY Chuk Shirley Sabel Steel Service Club Seiden

2 Senior Software Engineer Founder and Owner Subject Matter Expert

3 2015 Innovation Award

4 TODAY S TOPICS API concepts Apigility installation / Server configuration Creating RESTful web services Sanitizing input Using the toolkit Error handling Testing

5 WHAT IS AN API?

6 API TERMINOLOGY API = Application Programming Interface An API is a way for two computer applications to talk to each other over a network using a common language that they both understand. Examples: IBM i OS commands (CRTLIB, DSPJOBLOG) jquery methods (jquery.ajax(), jquery.on()) RPG built-in functions (%DEC, %XLATE) Jacobson, Daniel and Greg Brail. Sebastopol, APIs: A S

7 API TERMINOLOGY API vs Web API A Web API is an API accessed over HTTP Web service vs Web API A web service refers to one or many related API functions A web API is a collection of web services

8 APPLICATION LAYERS Web API Presentation Application & Domain Persistence Web (HTML, CSS, JS) PHP Db2 Mobile (Objective C, Cordova) CL, RPG, COBOL, Java Sessions Toaster app SQL Cache

9 LAYER COMMUNICATION Web API Presentation layer HTTP Request HTTP Response Application /Domain layers DB Interactions Persistence layer

10 APIGILITY INSTALLATION

11 REQUIREMENTS Code Editor (Zend Studio, RDi, Notepad, etc.) Zend Server 6 or above running PHP or above PHP Toolkit and XMLSERVICE Library REST Client (optional) Postman, curl, etc.

12 DEVELOPMENT METHODS Local Apigility admin UI runs locally Edit your code locally Push changes to server Remote Apigility admin UI runs on server Edit your code locally (pull files from server first) Push changes to server

13 DEVELOP LOCALLY Download PHP to your local computer Homebrew Macports All in one (MAMP, XAMPP, WAMP, etc.)

14 DOWNLOAD SKELETON APP Start PASE shell Add PHP executable to PATH environment variable

15 PHP 5.6 AND OPENSSL PHP 5.6 now verifies peer certificates by default Download good known CA bundle Change php.ini setting

16 VERIFY OPENSSL VERSION Only recent versions of OpenSSL can properly use this CA bundle. Make sure you re running at least Too old!

17 RUN APIGILITY INSTALLER Return to PASE and change directories to / Run the Apigility installer script Rename the directory to AcmeAPI

18 SERVER CONFIGURATION

19 DISABLE OPCACHE Enable opcache blacklist in php.ini Create file opcache_blacklist.txt and add two entries

20 DISABLE APC CACHE Change PHP setting in datacache.ini Set zend_datacache.apc_compatibility to 0

21 CONFIGURE DIRECTORY PERMISSIONS Make /config and /module directories writable by web server

22 ADD APACHE VIRTUAL HOST In /www/zendsvr6/conf/httpd.conf Template is on next slide You ll need to supply three values: Server IP address/dns (10.x.x.x, 192.x.x.x, subdomain.domain.com) Port number **Choose one that isn t in use** Path to the project Restart Zend Server

23 Listen *:[port] NameVirtualHost *:[port] <VirtualHost *:[port]> ServerName [server ip]:[port]!!! DocumentRoot "/www/acmeapi/public" SetEnv APPLICATION_ENV "development" AllowEncodedSlashes On RewriteEngine on <Location /> RewriteEngine On RewriteCond %{REQUEST_FILENAME} -s [OR] RewriteCond %{REQUEST_FILENAME} -l [OR] RewriteCond %{REQUEST_FILENAME} -d RewriteRule ^.*$ - [NC,L] RewriteCond %{REQUEST_URI}::$1 ^(/.+)(.+)::\2$ RewriteRule ^(.*) - [E=BASE:%1] RewriteRule ^(.*)$ %{ENV:BASE}index.php [NC,L] </Location> </VirtualHost>

24 APIGILITY WELCOME PAGE ip]:[port]/

25 CREATING RESTFUL WEB SERVICES

26 INITIALIZING THE DB2 TABLE CREATE TABLE MY_LIB.CUSTOMERS ( ID BIGINT GENERATED ALWAYS AS IDENTITY (START WITH 1, INCREMENT BY 1, NO ORDER, NO CYCLE, NO MINVALUE, NO MAXVALUE, CACHE 20), NAME VARCHAR (50), ADDRESS VARCHAR (75) );

27 DESIGNING THE URIS HTTP Request Method Example URI Task GET /customer Lists all rows POST /customer Creates new row in db GET /customer/{customer id} Fetch a particular row PUT /customer/{customer id} Update row in db DELETE /customer/{customer id} Remove row from db

28 USING THE ADMIN INTERFACE Designing the URIs

34 PROJECT STRUCTURE

40 SANITIZING INPUT

41 ADDING VALIDATION

42 ADDING VALIDATION

43 ADD FILTERING

44 ADD FILTERING

45 USING THE TOOLKIT

46 ZF2 SERVICES The toolkit should be used as a service Services are configured in the Service Manager PHP array Assembled at runtime from many locations Global application services located at /config/autoload/application.config.php

47 ADDING DB2 SERVICE

48 ADDING TOOLKIT SERVICE

49 PROJECT STRUCTURE

50 USING THE TOOLKIT

51 USING THE TOOLKIT

52 USING THE TOOLKIT (PHP)

53 USING THE TOOLKIT (CL)

54 USING THE TOOLKIT (RPG)

55 USING THE TOOLKIT (RPG)

56 USING THE TOOLKIT (PHP)

57 ERROR HANDLING

58 ERROR HANDLING Use HTTP response status codes for errors Apigility supports API Problem format Uses application/problem+json mediatype

59 SENDING THE API PROBLEM You can produce an API Problem with one of two methods: return new \ZF\ApiProblem\ApiProblemResponse() throw new Exception()

60 THROWING AN EXCEPTION

61 THROWING AN EXCEPTION

62 CUSTOMERRESOURCE::FETCH ()

65 TESTING YOUR API

66 ADDITIONAL RESOURCES This presentation s GitHub repo: Apigility documentation: HTTP status codes cheat sheet:

67 QUESTIONS?

Zend Framework for IBM i

Zend Framework for IBM i Part II: MVC and ZF Applications Who is Jeff Olen? Author of bestselling IBM i Programmers Guide to PHP Zend Certified Engineer PHP 5 IBM i developer for 20+ years Co-founder of