Downloaded 13 times
Uploaded byRoel Hartman
Wizard of ORDS
This document discusses Oracle REST Data Services (ORDS) and how it can be used to expose database objects like tables, views, procedures, and functions through RESTful APIs. It provides examples of enabling different database objects as REST resources and configuring the exposed APIs. It also covers more advanced topics like parameter passing, result handling, authentication, and protecting resources with OAuth client credentials.
More Related Content
Wizard of ORDS
- 1.
- 3.
- 4. Request (PL)SQL ResultResponse Parse &Map Collect
- 5.
- 6. Build your APIlike a wall
- 7. script1.sql “DATA” SCHEMA “API” SCHEMA “API”URL MAPPING
- 8. ords.enable_schema begin ords.enable_schema ( p_url_mapping_pattern =>'api' ); commit; end; / script1.sql
- 9. ords.enable_object begin ords.enable_object ( p_object =>'MY_CUSTOMERS_VW' , p_object_type => 'VIEW' , p_object_alias => 'customers' ); commit; end; / script2.sql
- 10. anatomy of anords autorest URL https://apex.apexconsulting.nl/api/customers /1 /?q={"CUST_STATE" :"VA"} /?q={"$orderby":{"CUST_CITY":"ASC"}} /?offset=2&limit=2 ERROR - Missing PK (only for views) alter view my_customers_vw add constraint cust_pk primary key( customer_id ) rely disable novalidate
- 11. but wait … there’smore than just GET select method, base_path, pattern from user_ords_services /
- 12. but wait … there’smore than just GET METHOD BASE_PATH PATTERN _________ ______________ ____________ DELETE /customers/ . GET /customers/ . POST /customers/ . POST /customers/ batchload DELETE /customers/ :id GET /customers/ :id PUT /customers/ :id
- 13. post { "CUSTOMER_ID": 10, "CUST_FIRST_NAME": "Roel", "CUST_LAST_NAME":"Hartman", "CUST_STREET_ADDRESS1": "Draaiomsweg 31", "CUST_STREET_ADDRESS2": "", "CUST_CITY": "Diepenveen", "CUST_STATE": "NL", "CUST_POSTAL_CODE": "7431CW", "CUST_EMAIL": "roelhartman@gmail.com", "PHONE_NUMBER1": "123", "PHONE_NUMBER2": "456", "URL": "http://roelhartman.blogspot.com", "CREDIT_LIMIT": 1000, "TAGS": "NOTHING" }
- 14. put { "CUSTOMER_ID": 10, "CUST_FIRST_NAME": "Roel", "CUST_LAST_NAME":"Hartman", "CUST_STREET_ADDRESS1": "Draaiomsweg 31", "CUST_STREET_ADDRESS2": "", "CUST_CITY": "Diepenveen", "CUST_STATE": "NL", "CUST_POSTAL_CODE": "7431CW", "CUST_EMAIL": "roelhartman@gmail.com", "PHONE_NUMBER1": “06-121218219" } Missing elements wil be updated to NULL
- 15.
- 16.
- 17. Auto”REST” PL/SQL Objects • AlwaysPOST • Procedure returns { <out parameters> } • Function returns {“~ret":null} • Package : api/<package alias>/<OBJECT NAME> • No overloading (as it results in the same endpoints) script3a.sql
- 18. Our REST enabledobjects METHOD BASE_PATH PATTERN NAME _________ ______________ ____________ __________________ GET /customers/ . MY_CUSTOMERS_VW DELETE /customers/ . MY_CUSTOMERS_VW POST /customers/ . MY_CUSTOMERS_VW POST /customers/ batchload MY_CUSTOMERS_VW PUT /customers/ :id MY_CUSTOMERS_VW DELETE /customers/ :id MY_CUSTOMERS_VW GET /customers/ :id MY_CUSTOMERS_VW POST /proc1/ . WOO_PROC1 POST /func1/ . WOO_FUNC1 POST /pkg/ PROC WOO_PKG POST /pkg/ FUNC WOO_PKG
- 19. Parameters & returnvalues Procedure • In - json payload • Out - {“p_result”:9} script3b.sql Function • In - json payload • Out - {“~ret”:9}
- 20. JSON results set Usesys_refcursor script3c.sql
- 21. Nested JSON resultset sys_refcursor returning a nested cursor script3d.sql
- 22. You need fullcontrol? begin ords.define_service ( p_module_name => 'customers' , p_base_path => 'sales' , p_pattern => 'customers/:custid' , p_source => 'select * from my_customers_vw where customer_id = :custid' ); commit; end; script3e.sql
- 23. Why AutoREST? reusable testabledependency analysis compiled
- 24. Full SQL power overREST !
- 25.
- 26. REST enabled SQL HT T P S
- 27.
- 28. REST enabled SQL Content-Type: application/sql
- 29. REST enabled SQL runjust 1 statement
- 30. REST enabled SQL runa sql file
- 31. REST enabled SQL runa JSON file containing multiple statements
- 32.
- 33. Creating a protected service begin ords.enable_object (p_object => 'WOO_SECRET' , p_object_type => 'PROCEDURE' , p_object_alias => 'secret' , p_auto_rest_auth => true ); commit; end; / script4.sql
- 34.
- 35. Privileges & Roles •oracle.dbtools.autorest.privilege.ORDS_API.WOO_SECRET • oracle.dbtools.role.autorest.ORDS_API.WOO_SECRET roles privileges • Or create your own privileges, roles and privilege mappings protected resources
- 36.
- 37. OAuth 2 -Client Credentials begin oauth.create_client ( p_name => 'woo client' , p_grant_type => 'client_credentials' , p_owner => 'Wizardry Ltd.' , p_description => 'A client for woo' , p_support_email => 'roelhartman@gmail.com' , p_privilege_names => 'oracle.dbtools.autorest.privilege.ORDS_API.WOO_SECRET' ); commit; end; 1 Create an OAuth Client
- 38. OAuth 2 -Client Credentials begin oauth.grant_client_role ( p_client_name => 'woo client' , p_role_name => 'oracle.dbtools.role.autorest.ORDS_API.WOO_SECRET' ); commit; end; 1 2 Create an OAuth Client Grant Role to Client
- 39. OAuth 2 -Client Credentials select name, client_id, client_secret from user_ords_clients NAME CLIENT_ID CLIENT_SECRET _____________ ___________________________ ___________________________ woo client dQlv60aY13Ly44UGhsZqbw.. IkvcfreAUE4sB2D9f5Nwf2A.. 1 2 3 Create an OAuth Client Grant Role to Client Get Client ID & Client Secret
- 40. OAuth 2 -Client Credentials curl -i -k --user <Client ID>:<Client Secret> —data "grant_type=client_credentials" https://localhost:8443/ords/pdb191/api/oauth/token 1 2 3 4 Create an OAuth Client Grant Role to Client Get Client ID & Client Secret Get a token
- 41. OAuth 2 -Client Credentials {“access_token”:”<token>","token_type":"bearer","expires_in":3600} 1 2 3 4 Create an OAuth Client Grant Role to Client Get Client ID & Client Secret Get a token
- 42. OAuth 2 -Client Credentials 1 2 3 4 5 Create an OAuth Client Grant Role to Client Get Client ID & Client Secret Get a token Use the token 1.curl --request POST -i -k -H"Authorization: Bearer <token>” 2.https://localhost:8443/ords/pdb191/api/secret/
- 46. Copyright © 2019APEX Consulting Q& A@roelh roel@apexconsulting.nl http://www.apexconsulting.nl
- 47.