Boost Your Content Strategy for REST APIs with Gururaj BS
0 likes328 views
The document serves as an introductory guide to REST APIs, detailing the HTTP request-response model, HTTP methods, and status codes. It outlines the process for using Oracle Storage Cloud Service, including obtaining authentication tokens and performing CRUD operations. Additionally, it provides various resources for further learning about REST, JSON, and HTTP specifications.
Boost Your Content Strategy for REST APIs with Gururaj BS
- 2. Copyright © 2014 Oracle and/or its affiliates. All rights reserved. | 15-Minute Intro to REST APIs Gururaj (Guru) @guru_bs Information Development World September 30, 2015
- 3. Copyright © 2015 Oracle and/or its affiliates. All rights reserved. | About HTTP Oracle Confidential – Internal/Restricted/Highly Restricted 3 • Request-response protocol • HTTP client and HTTP server (optional HTTP proxy) protocol HTTP Client (Browser) HTTP Server (Web Server) Request message Response message <Initial line – different for request and response> Header1: value1 Header2: value2 Header3: value3 <optional message body>
- 4. Copyright © 2015 Oracle and/or its affiliates. All rights reserved. | HTTP message format examples Oracle Confidential – Internal/Restricted/Highly Restricted 4 REQUEST initiated by an HTTP Client <Method> <Request URI> HTTP/<version> GET </path/to/file/index.html> HTTP/1.1 Header1: value1 Header2: value2 Header3: value3 RESPONSE sent by an HTTP Server HTTP/1.1 <HTTP status code> Header1: value1 Header2: value2 Header3: value3 <optional message body> <Content Type> (text/html, image/gif etc) <Content Length>
- 5. Copyright © 2015 Oracle and/or its affiliates. All rights reserved. | Here’s an example… Oracle Confidential – Internal/Restricted/Highly Restricted 5
- 6. Copyright © 2015 Oracle and/or its affiliates. All rights reserved. | What and where example • Data in a table is a resource we want to read • Database server is called database1 • Database called sampledb • Table called employees http://database1/sampledb/employees • What type of content you return is up to you – XML and JSON are common Oracle Confidential – Internal/Restricted/Highly Restricted 6
- 7. Copyright © 2015 Oracle and/or its affiliates. All rights reserved. | REST client interfaces Oracle Confidential – Internal/Restricted/Highly Restricted 7 Interface REST plugin examples Command line cURL Download link: Use cURL download wizard (http://curl.haxx.se/download.html) Installation instructions: On UNIX: http://www.unixnewbie.org/how-to-install-curl/ On Windows (you need cygwin - https://www.cygwin.com/) – use my team’s cURL on Windows installation tutorial - http://www.oracle.com/webfolder/technetwork/tutorials/obe/cloud/objectstorage/installing_cURL/installing_c URL.html Desktop RESTClient (wiztools.org) – The GUI version will be used in the demo today. Download link: http://code.fosshub.com/WizToolsorg-RESTClient/downloads Browser REST Easy (a Firefox plugin) Download link: https://addons.mozilla.org/EN-us/firefox/addon/rest-easy/
- 8. Copyright © 2015 Oracle and/or its affiliates. All rights reserved. | HTTP methods Oracle Confidential – Internal/Restricted/Highly Restricted 8 Method Description OPTIONS Returns HTTP methods and other options supported by a RESTful service GET Retrieves a single resource, or retrieve all resources in a collection HEAD Retrieves a single resource, or retrieve all resources in a collection (headers only) POST Create a new resource in a collection PUT Update a resource (full update) PATCH Update a resource (delta update) – RFC 5789 DELETE Delete a resource
- 9. Copyright © 2015 Oracle and/or its affiliates. All rights reserved. | HTTP statuses Oracle Confidential – Internal/Restricted/Highly Restricted 9 Status Code Description 1xx Informational - request received, continuing process 2xx Success - action requested by the client was received, understood, accepted and processed successfully 3xx Client must take additional action to complete the request. Many of these status codes are used in URL redirection 4xx Client errors 5xx Server errors
- 10. Copyright © 2015 Oracle and/or its affiliates. All rights reserved. | Intro to the demo We will use Oracle Storage Cloud Service, an object storage solution from Oracle built on top of open stack swift API 1. Sign up for Oracle Storage Cloud Service trial – REST end point/URL – User name and password 2. Get an authentication token (GET) – 30-minute validity – a different service with its own end point to grant a time-bound token 3. See which HTTP methods are supported (OPTIONS) 4. Create a storage Container (PUT) 5. Set container metadata (POST): number of objects in a container 6. Delete the container (DELETE) Oracle Confidential – Internal/Restricted/Highly Restricted 10
- 11. Copyright © 2015 Oracle and/or its affiliates. All rights reserved. | Demo Screenshots Oracle Confidential – Internal/Restricted/Highly Restricted 11
- 12. Copyright © 2015 Oracle and/or its affiliates. All rights reserved. | Oracle Confidential – Internal/Restricted/Highly Restricted 12 REST endpoint
- 13. Copyright © 2015 Oracle and/or its affiliates. All rights reserved. | Useful links • XML and JSON examples: http://json.org/example • HTTP spec: http://www.w3.org/Protocols/rfc2616/rfc2616.html • A story of how a web developer explained REST to his wife: http://www.looah.com/source/view/2284 • HTTP status codes: http://httpstatus.es/ • Oracle Storage Cloud Service Trial: http://cloud.oracle.com/storage • My team’s cURL on Windows installation tutorial - http://www.oracle.com/webfolder/technetwork/tutorials/obe/cloud/objectstorage/installing_cURL/insta lling_cURL.html • Oracle Storage Cloud Service documentation: http://docs.oracle.com/cloud/latest/storagecs_common/CSSTO/GUID-5778ADBB-A0E8-4451-B886- 362A3B7237DB.htm#CSSTO3177 Oracle Confidential – Internal/Restricted/Highly Restricted 13
- 14. Copyright © 2015 Oracle and/or its affiliates. All rights reserved. | Demo screenshots Oracle Confidential – Internal/Restricted/Highly Restricted 14
- 15. Copyright © 2015 Oracle and/or its affiliates. All rights reserved. | Authentication Error Oracle Confidential – Internal/Restricted/Highly Restricted 15
- 16. Copyright © 2015 Oracle and/or its affiliates. All rights reserved. | GET – Authentication Token Oracle Confidential – Internal/Restricted/Highly Restricted 16
- 17. Copyright © 2015 Oracle and/or its affiliates. All rights reserved. | OPTIONS – View the methods allowed Oracle Confidential – Internal/Restricted/Highly Restricted 17
- 18. Copyright © 2015 Oracle and/or its affiliates. All rights reserved. | PUT – Create a container Oracle Confidential – Internal/Restricted/Highly Restricted 18
- 19. Copyright © 2015 Oracle and/or its affiliates. All rights reserved. | GET– View the newly created container Oracle Confidential – Internal/Restricted/Highly Restricted 19
- 20. Copyright © 2015 Oracle and/or its affiliates. All rights reserved. | POST– set container metadata (quota and number of objects) Oracle Confidential – Internal/Restricted/Highly Restricted 20
- 21. Copyright © 2015 Oracle and/or its affiliates. All rights reserved. | POST– status Oracle Confidential – Internal/Restricted/Highly Restricted 21
- 22. Copyright © 2015 Oracle and/or its affiliates. All rights reserved. | DELETE– delete the container Oracle Confidential – Internal/Restricted/Highly Restricted 22
- 23. Copyright © 2015 Oracle and/or its affiliates. All rights reserved. | GET– view the list of containers to verify the deletion of Guru_Cont4 Oracle Confidential – Internal/Restricted/Highly Restricted 23
Editor's Notes
- #3: This is a Title Slide with Picture slide ideal for including a picture with a brief title, subtitle and presenter information. To customize this slide with your own picture: Right-click the slide area and choose Format Background from the pop-up menu. From the Fill menu, click Picture and texture fill. Under Insert from: click File. Locate your new picture and click Insert.
- #12: This slide can also be used as a Q and A slide
- #13: This slide can also be used as a Q and A slide
- #15: This slide can also be used as a Q and A slide