SlideShare une entreprise Scribd logo
1  sur  39
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. |
Boost Your Content Strategy
for REST APIs
Marta Rauch
@martarauch
Information Development World
October 1, 2015
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. |
Safe Harbor Statement
The following is intended to outline our general product direction. It is intended for
information purposes only, and may not be incorporated into any contract. It is not a
commitment to deliver any material, code, or functionality, and should not be relied upon
in making purchasing decisions. The development, release, and timing of any features or
functionality described for Oracle’s products remains at the sole discretion of Oracle.
2
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. |
What we’ll look at
Importance of REST APIs
Best practices for REST API content
Oracle REST APIs
Learn more
1
2
3
33/3/2015
4
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. |
Importance of REST APIs
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. |
• Growing rapidly, industry standard
• Fast, scalable, reliable
• Great for mobile, wearables, IoT,
analytics, SEO
REST = REpresentational State Transfer
An architecture for client-server web communication
5https://en.wikipedia.org/wiki/Representational_state_transfer
Web Technologies, APIs, SOAP, REST - 2014
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. |
Examples:
• Cloud services
• Mobile apps
• Internet of Things (IoT)
API = Application Programming Interface
Lets products and services communicate with each other
6
http://medianetwork.oracle.com/video/player/3630043914001
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. |
APIs are growing quickly
7http://www.programmableweb.com/api-research
Programmable Web
http://www.programmableweb.com/api-research
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. |
Finance and Enterprise are the fastest growing API categories
8
Programmable Web
http://www.programmableweb.com/api-research
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. |
of new APIs are REST APIs
90%
9
http://blog.soa.com/raml-birth-api-description-
language-fit-enterprise/
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. |
Best Practices for REST API content
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. |
Get developers started quickly
Include useful reference information
Provide sample code
Provide a list of REST endpoints
Represent resources with a description language
Provide a modern, usable UX
Content for REST APIs
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. |
Get developers
started quickly
Why use this API
Base URL
Get an API key
Authentication
Error handling
HTTP status codes
Scenarios, use cases
12
Peter Gruenbaum founder of SDK Bridge
Web API Documentation Best Practices
The Five Biggest API Doc Mistakes and How To Avoid Them
Survey of SDK Documentation
Explaining how your API uses OAuth REST API for Oracle Java Cloud Service: http://docs.oracle.com/cloud/latest/jcs_gs/JSRMR/
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. |
Name
Method
GET, POST, PUT, DELETE…
URL structure
Overview
Parameters
Descriptions
Remarks
Examples
REST endpoints
13
Peter Gruenbaum founder of SDK Bridge
Web API Documentation Best Practices
Irene Ros, REST API Documentation
Best practices for API docs, Andrya Feinberg
Include useful reference information
REST API for Oracle Java Cloud Service: http://docs.oracle.com/cloud/latest/jcs_gs/JSRMR/
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. |
Group topics
into
categories
14
Makes larger
API docs
more
readable
REST API for Oracle Java Cloud Service: http://docs.oracle.com/cloud/latest/jcs_gs/JSRMR/
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. |
Example requests,
responses,
use cases
In the programming
languages that
your customers use
Test code samples
15
API Explorers, by Sarah Maddox
Learning how developers think, by Joe Malin
A coder’s guide to writing API documentation
Code Samples by Tom Johnson
Documenting REST APIs, Jody Bleyle Jennifer Rondeau
Provide
sample code
REST API for Oracle Java Cloud Service: http://docs.oracle.com/cloud/latest/jcs_gs/JSRMR/
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. |
Example:
Sample Code
16
Helps developers
understand
real-world
applications
REST API for Oracle Java Cloud Service: http://docs.oracle.com/cloud/latest/jcs_gs/JSRMR/
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. |
Provide quick access
to request and
response
17
A tabbed UI
improves
usability
REST API for Oracle Java Cloud Service: http://docs.oracle.com/cloud/latest/jcs_gs/JSRMR/
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. |
Example:
Request
18
REST API for Oracle Java Cloud Service: http://docs.oracle.com/cloud/latest/jcs_gs/JSRMR/
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. |
Example:
Response
19
REST API for Oracle Java Cloud Service: http://docs.oracle.com/cloud/latest/jcs_gs/JSRMR/
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. |
Provide a list of REST endpoints
20
REST API for Oracle Java Cloud Service: http://docs.oracle.com/cloud/latest/jcs_gs/JSRMR/
Gives developers
an alternate
way
to access
information
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. |
Allows docs to be
generated,
automated
Example frameworks
Swagger
Raml
JSON Schema Hypermedia
21
API Description Languages: Which one is right for me? by Laura Heritage
Does one API language fit an entire enterprise? By Laura Heritage
Overview of RESTful API Description Languages
Represent resources
with an API
description
language
https://github.com/swagger-api/swagger-
spec/blob/master/examples/v2.0/json/petstore-simple.json
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. | 22
Peter Gruenbaum founder of SDK Bridge Web
API Documentation Best Practices
Automating REST API documentation
Provide a modern, usable UX
REST API for Oracle Java Cloud Service: http://docs.oracle.com/cloud/latest/jcs_gs/JSRMR/
Interactive
web UI
enables
quick access
to resources
and examples
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. |
Get developers started quickly
Include useful reference information
Provide sample code
Provide a list of REST endpoints
Represent resources with a description language
Provide a modern, usable UX
Content for REST APIs
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. |
Get developers started quickly
Include useful reference information
Provide sample code
Provide a list of REST endpoints
Represent resources with a description language
Provide a modern, usable UX
Content for REST APIs
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. |
Oracle REST APIs
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. |
API Documentation Generation
To auto-generate API resource reference for docs, development teams
• Include required information in the API description for each resource
• Adopt one of the API description frameworks recommended to Oracle teams
• Use a REST Publishing app to register and publish APIs
Swagger
RAML
API docs
JSON Schema
Hypermedia
Publishing app converts to
HTML from REST templates
Canonical description
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. | 27
Product Build Systems
in DEV Environments
REST Publishing
App
Oracle Authoring Systems
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. |
Swagger and Raml
http://swagger.io/
http://swagger.io/specification/
http://raml.org/
http://raml.org/spec.html
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. |
Sample REST API docs
REST APIs for Oracle Mobile Cloud Service
https://docs.oracle.com/cloud/latest/mobilecs_gs/MCSRA/
REST APIs for Oracle Social Data and Insight Cloud Service
http://docs.oracle.com/cloud/latest/datacs_common/RRDAT/
REST APIs for Oracle Java Cloud Service
https://docs.oracle.com/cloud/latest/jcs_gs/JSRMR/
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. |
Learn More
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. |
Peter Gruenbaum, SDK Bridge:
API Documentation 1: JSON and XML for Technical Writers http://sdkbridge.com/online-courses/
API Documentation 2: REST for Writers http://sdkbridge.com/online-courses/
Tom Johnson’s API doc posts http://idratherbewriting.com/category/api-documentation/
and online class http://idratherbewriting.com/docapis_course_overview/
Examples from REST API for Oracle Java Cloud Service: http://docs.oracle.com/cloud/latest/jcs_gs/JSRMR/
STC Intercom API issue http://intercom.stc.org/magazine/september-2014/features-september-2014/
How do you break into API documentation? http://intercom.stc.org/2014/09/how-do-you-break-into-api-documentation/
Lessons learned as a novice API writer http://intercom.stc.org/2014/09/lessons-learned-as-a-novice-api-writer/
How to write helpful code samples http://intercom.stc.org/2014/09/how-to-write-helpful-code-samples/
Sarah Maddox, Intro to API technical writing http://www.slideshare.net/sarahmaddox/api-technical-writing
Marta Rauch’s API Pinterest posts https://www.pinterest.com/martarauch/apis/
Learn API technical writing https://www.udemy.com/api-documentation-1-json-and-xml/?couponCode=apidoc
Learn APIs with Codecademy http://www.codecademy.com/blog/52-learn-apis-with-codecademy
Get started, take a class
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. |
STC webinar API series – Sarah Maddox Intro to APIs, Joe Malin Helping the Code tell the Story
Web API Documentation Best Practices by Peter Gruenbaum
Documenting your API by Irene Ros
Sarah Maddox API posts
Documenting REST APIs by Jody Bleyle and Jennifer Rondeau
The Five Biggest API Mistakes and how to Avoid Them by Peter Gruenbaum
Survey on Documentation by Peter Gruenbaum
Good Sample Code by Peter Gruenbaum
Creating code samples for API/SDK documentation by Tom Johnson
Automating REST API documentation by Tom Johnson and Peter Gruenbaum
API Description Languages: Which one is right for me? by Laura Heritage
Does one API language fit an entire enterprise? By Laura Heritage
REST API documentation
Raml: The birth of an API description language fit for enterprise
How APIs can enable IDEs
Helpful information
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. |
Get developers started quickly
Include useful reference information
Provide sample code
Provide a list of REST endpoints
Represent resources with a description language
Provide a modern, usable UX
Content for REST APIs
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. |
What we looked at
Importance of REST APIs
Best practices for REST API content
Oracle REST APIs
Learn more
1
2
3
34
4
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. |
• @martarauch
• Marta Rauch
• +Marta Rauch
• Marta Rauch
• Marta Rauch
Connect
with me!
Thank You!
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. |
Marta Rauch works in a development team at Oracle, where she architects and leads mobile,
cloud, and REST API projects. She works on REST API guides and integration guides, provides input to
corporate REST API standards, and participates with a team that develops a new REST API interface.
She also enjoys participating in design jams and developer challenges for mobile, augmented reality, beacons,
Internet of Things, data visualization, and wearable technology.
A frequent presenter for conferences and webinars, Marta has published articles for IEEE, HCII, STC, and CIDM Best
Practices. She contributed information to Developing User Assistance for Mobile Apps, by Joe Welinske, and her
augmented reality topic appears in The Language of Content Strategy by Rahel Bailie and Scott Abel.
An STC Associate Fellow, Marta has received 15 awards for her projects at the regional and international level. She is VP
of the Silicon Valley chapter and a member of the Nominating Committee. She is Tools & Development track manager
for Summit 2016 proposals, and judges International Summit Awards.
Marta has a degree from Stanford University and certificates from Notre Dame De Namur and University of California.
About the speaker @martarauch
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. |
Safe Harbor Statement
The preceding is intended to outline our general product direction. It is intended for
information purposes only, and may not be incorporated into any contract. It is not a
commitment to deliver any material, code, or functionality, and should not be relied upon
in making purchasing decisions. The development, release, and timing of any features or
functionality described for Oracle’s products remains at the sole discretion of Oracle.
37
Copyright © 2015, Oracle and/or its affiliates. All rights reserved. | 38
Boost Your Content Strategy for REST APIs

Contenu connexe

Tendances

Oracle ADF Architecture TV - Design - ADF Service Architectures
Oracle ADF Architecture TV - Design - ADF Service ArchitecturesOracle ADF Architecture TV - Design - ADF Service Architectures
Oracle ADF Architecture TV - Design - ADF Service ArchitecturesChris Muir
 
JFall 2016: Oracle JET Session
JFall 2016: Oracle JET SessionJFall 2016: Oracle JET Session
JFall 2016: Oracle JET SessionGeertjan Wielenga
 
OOW16 - Migrating and Managing Customizations for Oracle E-Business Suite 12....
OOW16 - Migrating and Managing Customizations for Oracle E-Business Suite 12....OOW16 - Migrating and Managing Customizations for Oracle E-Business Suite 12....
OOW16 - Migrating and Managing Customizations for Oracle E-Business Suite 12....vasuballa
 
Oracle ADF Architecture TV - Design - MDS Infrastructure Decisions
Oracle ADF Architecture TV - Design - MDS Infrastructure DecisionsOracle ADF Architecture TV - Design - MDS Infrastructure Decisions
Oracle ADF Architecture TV - Design - MDS Infrastructure DecisionsChris Muir
 
OOW16 - Testing Oracle E-Business Suite Best Practices [CON6713]
OOW16 - Testing Oracle E-Business Suite Best Practices [CON6713]OOW16 - Testing Oracle E-Business Suite Best Practices [CON6713]
OOW16 - Testing Oracle E-Business Suite Best Practices [CON6713]vasuballa
 
Pimping SQL Developer and Data Modeler
Pimping SQL Developer and Data ModelerPimping SQL Developer and Data Modeler
Pimping SQL Developer and Data ModelerKris Rice
 
OOW16 - Oracle E-Business Suite Information Discovery: Your Journey to the Cl...
OOW16 - Oracle E-Business Suite Information Discovery: Your Journey to the Cl...OOW16 - Oracle E-Business Suite Information Discovery: Your Journey to the Cl...
OOW16 - Oracle E-Business Suite Information Discovery: Your Journey to the Cl...vasuballa
 
Oracle SQL Developer Data Modeler - Version Control Your Designs
Oracle SQL Developer Data Modeler - Version Control Your DesignsOracle SQL Developer Data Modeler - Version Control Your Designs
Oracle SQL Developer Data Modeler - Version Control Your DesignsJeff Smith
 
Oracle ADF Architecture TV - Planning & Getting Started - Team, Skills and D...
Oracle ADF Architecture TV -  Planning & Getting Started - Team, Skills and D...Oracle ADF Architecture TV -  Planning & Getting Started - Team, Skills and D...
Oracle ADF Architecture TV - Planning & Getting Started - Team, Skills and D...Chris Muir
 
Coding from Application Container Cloud to Oracle JET
Coding from Application Container Cloud to Oracle JETCoding from Application Container Cloud to Oracle JET
Coding from Application Container Cloud to Oracle JETGeertjan Wielenga
 
Oracle JET: Enterprise-Ready JavaScript Toolkit
Oracle JET: Enterprise-Ready JavaScript ToolkitOracle JET: Enterprise-Ready JavaScript Toolkit
Oracle JET: Enterprise-Ready JavaScript ToolkitGeertjan Wielenga
 
Oracle JET, with JET Mobile Content
Oracle JET, with JET Mobile ContentOracle JET, with JET Mobile Content
Oracle JET, with JET Mobile ContentGeertjan Wielenga
 
Oracle ADF Architecture TV - Development - Logging
Oracle ADF Architecture TV - Development - LoggingOracle ADF Architecture TV - Development - Logging
Oracle ADF Architecture TV - Development - LoggingChris Muir
 
Découvrons Oracle Cloud Platform for Integration - Oracle Integration Cloud
Découvrons Oracle Cloud Platform for Integration - Oracle Integration CloudDécouvrons Oracle Cloud Platform for Integration - Oracle Integration Cloud
Découvrons Oracle Cloud Platform for Integration - Oracle Integration CloudSanae BEKKAR
 
Oracle Solaris Cloud Management and Deployment with OpenStack
Oracle Solaris Cloud Management and Deployment with OpenStackOracle Solaris Cloud Management and Deployment with OpenStack
Oracle Solaris Cloud Management and Deployment with OpenStackOTN Systems Hub
 
Oracle ADF Architecture TV - Design - Service Integration Architectures
Oracle ADF Architecture TV - Design - Service Integration ArchitecturesOracle ADF Architecture TV - Design - Service Integration Architectures
Oracle ADF Architecture TV - Design - Service Integration ArchitecturesChris Muir
 
B7 api management_enabling_digital_transformation
B7 api management_enabling_digital_transformationB7 api management_enabling_digital_transformation
B7 api management_enabling_digital_transformationDr. Wilfred Lin (Ph.D.)
 

Tendances (20)

Ebr the key_to_online_application_upgrade at amis25
Ebr the key_to_online_application_upgrade at amis25Ebr the key_to_online_application_upgrade at amis25
Ebr the key_to_online_application_upgrade at amis25
 
Oracle ADF Architecture TV - Design - ADF Service Architectures
Oracle ADF Architecture TV - Design - ADF Service ArchitecturesOracle ADF Architecture TV - Design - ADF Service Architectures
Oracle ADF Architecture TV - Design - ADF Service Architectures
 
JavaCro'15 - Java Cloud - Marin Tadić
JavaCro'15 - Java Cloud - Marin TadićJavaCro'15 - Java Cloud - Marin Tadić
JavaCro'15 - Java Cloud - Marin Tadić
 
JFall 2016: Oracle JET Session
JFall 2016: Oracle JET SessionJFall 2016: Oracle JET Session
JFall 2016: Oracle JET Session
 
OOW16 - Migrating and Managing Customizations for Oracle E-Business Suite 12....
OOW16 - Migrating and Managing Customizations for Oracle E-Business Suite 12....OOW16 - Migrating and Managing Customizations for Oracle E-Business Suite 12....
OOW16 - Migrating and Managing Customizations for Oracle E-Business Suite 12....
 
Oracle ADF Architecture TV - Design - MDS Infrastructure Decisions
Oracle ADF Architecture TV - Design - MDS Infrastructure DecisionsOracle ADF Architecture TV - Design - MDS Infrastructure Decisions
Oracle ADF Architecture TV - Design - MDS Infrastructure Decisions
 
Oracle User Group Holland
Oracle User Group HollandOracle User Group Holland
Oracle User Group Holland
 
OOW16 - Testing Oracle E-Business Suite Best Practices [CON6713]
OOW16 - Testing Oracle E-Business Suite Best Practices [CON6713]OOW16 - Testing Oracle E-Business Suite Best Practices [CON6713]
OOW16 - Testing Oracle E-Business Suite Best Practices [CON6713]
 
Pimping SQL Developer and Data Modeler
Pimping SQL Developer and Data ModelerPimping SQL Developer and Data Modeler
Pimping SQL Developer and Data Modeler
 
OOW16 - Oracle E-Business Suite Information Discovery: Your Journey to the Cl...
OOW16 - Oracle E-Business Suite Information Discovery: Your Journey to the Cl...OOW16 - Oracle E-Business Suite Information Discovery: Your Journey to the Cl...
OOW16 - Oracle E-Business Suite Information Discovery: Your Journey to the Cl...
 
Oracle SQL Developer Data Modeler - Version Control Your Designs
Oracle SQL Developer Data Modeler - Version Control Your DesignsOracle SQL Developer Data Modeler - Version Control Your Designs
Oracle SQL Developer Data Modeler - Version Control Your Designs
 
Oracle ADF Architecture TV - Planning & Getting Started - Team, Skills and D...
Oracle ADF Architecture TV -  Planning & Getting Started - Team, Skills and D...Oracle ADF Architecture TV -  Planning & Getting Started - Team, Skills and D...
Oracle ADF Architecture TV - Planning & Getting Started - Team, Skills and D...
 
Coding from Application Container Cloud to Oracle JET
Coding from Application Container Cloud to Oracle JETCoding from Application Container Cloud to Oracle JET
Coding from Application Container Cloud to Oracle JET
 
Oracle JET: Enterprise-Ready JavaScript Toolkit
Oracle JET: Enterprise-Ready JavaScript ToolkitOracle JET: Enterprise-Ready JavaScript Toolkit
Oracle JET: Enterprise-Ready JavaScript Toolkit
 
Oracle JET, with JET Mobile Content
Oracle JET, with JET Mobile ContentOracle JET, with JET Mobile Content
Oracle JET, with JET Mobile Content
 
Oracle ADF Architecture TV - Development - Logging
Oracle ADF Architecture TV - Development - LoggingOracle ADF Architecture TV - Development - Logging
Oracle ADF Architecture TV - Development - Logging
 
Découvrons Oracle Cloud Platform for Integration - Oracle Integration Cloud
Découvrons Oracle Cloud Platform for Integration - Oracle Integration CloudDécouvrons Oracle Cloud Platform for Integration - Oracle Integration Cloud
Découvrons Oracle Cloud Platform for Integration - Oracle Integration Cloud
 
Oracle Solaris Cloud Management and Deployment with OpenStack
Oracle Solaris Cloud Management and Deployment with OpenStackOracle Solaris Cloud Management and Deployment with OpenStack
Oracle Solaris Cloud Management and Deployment with OpenStack
 
Oracle ADF Architecture TV - Design - Service Integration Architectures
Oracle ADF Architecture TV - Design - Service Integration ArchitecturesOracle ADF Architecture TV - Design - Service Integration Architectures
Oracle ADF Architecture TV - Design - Service Integration Architectures
 
B7 api management_enabling_digital_transformation
B7 api management_enabling_digital_transformationB7 api management_enabling_digital_transformation
B7 api management_enabling_digital_transformation
 

En vedette

Writing a book on a wiki: Does that even work?
Writing a book on a wiki: Does that even work?Writing a book on a wiki: Does that even work?
Writing a book on a wiki: Does that even work?Sarah Maddox
 
Api Documentation Checklist
Api Documentation ChecklistApi Documentation Checklist
Api Documentation ChecklistAPI2Cart
 
Collaboration: A hands-on demo using Confluence wiki
Collaboration: A hands-on demo using Confluence wikiCollaboration: A hands-on demo using Confluence wiki
Collaboration: A hands-on demo using Confluence wikiSarah Maddox
 
The future *is* technical communication
The future *is* technical communicationThe future *is* technical communication
The future *is* technical communicationSarah Maddox
 
REST API Doc Best Practices
REST API Doc Best PracticesREST API Doc Best Practices
REST API Doc Best PracticesMarta Rauch
 
Atlassian User Group, AUG Wiesbaden, 25 October 2012
Atlassian User Group, AUG Wiesbaden, 25 October 2012Atlassian User Group, AUG Wiesbaden, 25 October 2012
Atlassian User Group, AUG Wiesbaden, 25 October 2012Sarah Maddox
 
Confluence as platform for technical documentation
Confluence as platform for technical documentationConfluence as platform for technical documentation
Confluence as platform for technical documentationSarah Maddox
 

En vedette (7)

Writing a book on a wiki: Does that even work?
Writing a book on a wiki: Does that even work?Writing a book on a wiki: Does that even work?
Writing a book on a wiki: Does that even work?
 
Api Documentation Checklist
Api Documentation ChecklistApi Documentation Checklist
Api Documentation Checklist
 
Collaboration: A hands-on demo using Confluence wiki
Collaboration: A hands-on demo using Confluence wikiCollaboration: A hands-on demo using Confluence wiki
Collaboration: A hands-on demo using Confluence wiki
 
The future *is* technical communication
The future *is* technical communicationThe future *is* technical communication
The future *is* technical communication
 
REST API Doc Best Practices
REST API Doc Best PracticesREST API Doc Best Practices
REST API Doc Best Practices
 
Atlassian User Group, AUG Wiesbaden, 25 October 2012
Atlassian User Group, AUG Wiesbaden, 25 October 2012Atlassian User Group, AUG Wiesbaden, 25 October 2012
Atlassian User Group, AUG Wiesbaden, 25 October 2012
 
Confluence as platform for technical documentation
Confluence as platform for technical documentationConfluence as platform for technical documentation
Confluence as platform for technical documentation
 

Similaire à Boost Your Content Strategy for REST APIs

Leverage integration cloud_service_for_ebs_
Leverage integration cloud_service_for_ebs_Leverage integration cloud_service_for_ebs_
Leverage integration cloud_service_for_ebs_aioughydchapter
 
MySQL day Dublin - OCI & Application Development
MySQL day Dublin - OCI & Application DevelopmentMySQL day Dublin - OCI & Application Development
MySQL day Dublin - OCI & Application DevelopmentHenry J. Kröger
 
Modern App Development with Oracle Cloud
Modern App Development with Oracle CloudModern App Development with Oracle Cloud
Modern App Development with Oracle CloudJuan Carlos Ruiz Rico
 
Oracle REST Data Services Best Practices/ Overview
Oracle REST Data Services Best Practices/ OverviewOracle REST Data Services Best Practices/ Overview
Oracle REST Data Services Best Practices/ OverviewKris Rice
 
OOW16 - Leverage Oracle Integration Cloud Service for Oracle E-Business Suite...
OOW16 - Leverage Oracle Integration Cloud Service for Oracle E-Business Suite...OOW16 - Leverage Oracle Integration Cloud Service for Oracle E-Business Suite...
OOW16 - Leverage Oracle Integration Cloud Service for Oracle E-Business Suite...vasuballa
 
OOW15 - Oracle E-Business Suite Integration Best Practices
OOW15 - Oracle E-Business Suite Integration Best PracticesOOW15 - Oracle E-Business Suite Integration Best Practices
OOW15 - Oracle E-Business Suite Integration Best Practicesvasuballa
 
Practical guide to building public APIs
Practical guide to building public APIsPractical guide to building public APIs
Practical guide to building public APIsReda Hmeid MBCS
 
Extending Enterprise Applications to mobile interfaces-Final
Extending Enterprise Applications to mobile interfaces-FinalExtending Enterprise Applications to mobile interfaces-Final
Extending Enterprise Applications to mobile interfaces-FinalRohit Dhamija
 
TechTalk: Extend Existing Architectures to Digital Endpoints with CA API Mana...
TechTalk: Extend Existing Architectures to Digital Endpoints with CA API Mana...TechTalk: Extend Existing Architectures to Digital Endpoints with CA API Mana...
TechTalk: Extend Existing Architectures to Digital Endpoints with CA API Mana...CA Technologies
 
Oracle Mobile Solution Overview
Oracle Mobile Solution OverviewOracle Mobile Solution Overview
Oracle Mobile Solution OverviewMee Nam Lee
 
10 Building Blocks for Enterprise JavaScript
10 Building Blocks for Enterprise JavaScript10 Building Blocks for Enterprise JavaScript
10 Building Blocks for Enterprise JavaScriptGeertjan Wielenga
 
Oracle database 12c_and_DevOps
Oracle database 12c_and_DevOpsOracle database 12c_and_DevOps
Oracle database 12c_and_DevOpsMaria Colgan
 
Simplify DevOps with Microservices and Mobile Backends.pptx
Simplify DevOps with Microservices and Mobile Backends.pptxSimplify DevOps with Microservices and Mobile Backends.pptx
Simplify DevOps with Microservices and Mobile Backends.pptxssuser5faa791
 
Oracle API Platform Cloud Service Best Practices & Lessons Learnt
Oracle API Platform Cloud Service Best Practices & Lessons LearntOracle API Platform Cloud Service Best Practices & Lessons Learnt
Oracle API Platform Cloud Service Best Practices & Lessons Learntluisw19
 
API Platform Cloud Service best practice - OOW17
API Platform Cloud Service best practice - OOW17API Platform Cloud Service best practice - OOW17
API Platform Cloud Service best practice - OOW17Phil Wilkins
 
Oracle Application Express 20.2 New Features
Oracle Application Express 20.2 New FeaturesOracle Application Express 20.2 New Features
Oracle Application Express 20.2 New Featuresmsewtz
 
Orchestrating Legacy Services Into Contemporary RESTful WEB APIs With CA App ...
Orchestrating Legacy Services Into Contemporary RESTful WEB APIs With CA App ...Orchestrating Legacy Services Into Contemporary RESTful WEB APIs With CA App ...
Orchestrating Legacy Services Into Contemporary RESTful WEB APIs With CA App ...CA Technologies
 
Modern Application Development for the Enterprise
Modern Application Development for the EnterpriseModern Application Development for the Enterprise
Modern Application Development for the EnterpriseJuarez Junior
 
What's New in Oracle SQL Developer for 2018
What's New in Oracle SQL Developer for 2018What's New in Oracle SQL Developer for 2018
What's New in Oracle SQL Developer for 2018Jeff Smith
 

Similaire à Boost Your Content Strategy for REST APIs (20)

Leverage integration cloud_service_for_ebs_
Leverage integration cloud_service_for_ebs_Leverage integration cloud_service_for_ebs_
Leverage integration cloud_service_for_ebs_
 
MySQL day Dublin - OCI & Application Development
MySQL day Dublin - OCI & Application DevelopmentMySQL day Dublin - OCI & Application Development
MySQL day Dublin - OCI & Application Development
 
Modern App Development with Oracle Cloud
Modern App Development with Oracle CloudModern App Development with Oracle Cloud
Modern App Development with Oracle Cloud
 
Oracle REST Data Services Best Practices/ Overview
Oracle REST Data Services Best Practices/ OverviewOracle REST Data Services Best Practices/ Overview
Oracle REST Data Services Best Practices/ Overview
 
OOW16 - Leverage Oracle Integration Cloud Service for Oracle E-Business Suite...
OOW16 - Leverage Oracle Integration Cloud Service for Oracle E-Business Suite...OOW16 - Leverage Oracle Integration Cloud Service for Oracle E-Business Suite...
OOW16 - Leverage Oracle Integration Cloud Service for Oracle E-Business Suite...
 
OOW15 - Oracle E-Business Suite Integration Best Practices
OOW15 - Oracle E-Business Suite Integration Best PracticesOOW15 - Oracle E-Business Suite Integration Best Practices
OOW15 - Oracle E-Business Suite Integration Best Practices
 
Practical guide to building public APIs
Practical guide to building public APIsPractical guide to building public APIs
Practical guide to building public APIs
 
Extending Enterprise Applications to mobile interfaces-Final
Extending Enterprise Applications to mobile interfaces-FinalExtending Enterprise Applications to mobile interfaces-Final
Extending Enterprise Applications to mobile interfaces-Final
 
TechTalk: Extend Existing Architectures to Digital Endpoints with CA API Mana...
TechTalk: Extend Existing Architectures to Digital Endpoints with CA API Mana...TechTalk: Extend Existing Architectures to Digital Endpoints with CA API Mana...
TechTalk: Extend Existing Architectures to Digital Endpoints with CA API Mana...
 
Oracle Mobile Solution Overview
Oracle Mobile Solution OverviewOracle Mobile Solution Overview
Oracle Mobile Solution Overview
 
10 Building Blocks for Enterprise JavaScript
10 Building Blocks for Enterprise JavaScript10 Building Blocks for Enterprise JavaScript
10 Building Blocks for Enterprise JavaScript
 
Oracle database 12c_and_DevOps
Oracle database 12c_and_DevOpsOracle database 12c_and_DevOps
Oracle database 12c_and_DevOps
 
Simplify DevOps with Microservices and Mobile Backends.pptx
Simplify DevOps with Microservices and Mobile Backends.pptxSimplify DevOps with Microservices and Mobile Backends.pptx
Simplify DevOps with Microservices and Mobile Backends.pptx
 
Oracle API Platform Cloud Service Best Practices & Lessons Learnt
Oracle API Platform Cloud Service Best Practices & Lessons LearntOracle API Platform Cloud Service Best Practices & Lessons Learnt
Oracle API Platform Cloud Service Best Practices & Lessons Learnt
 
API Platform Cloud Service best practice - OOW17
API Platform Cloud Service best practice - OOW17API Platform Cloud Service best practice - OOW17
API Platform Cloud Service best practice - OOW17
 
Imworld.ro
Imworld.roImworld.ro
Imworld.ro
 
Oracle Application Express 20.2 New Features
Oracle Application Express 20.2 New FeaturesOracle Application Express 20.2 New Features
Oracle Application Express 20.2 New Features
 
Orchestrating Legacy Services Into Contemporary RESTful WEB APIs With CA App ...
Orchestrating Legacy Services Into Contemporary RESTful WEB APIs With CA App ...Orchestrating Legacy Services Into Contemporary RESTful WEB APIs With CA App ...
Orchestrating Legacy Services Into Contemporary RESTful WEB APIs With CA App ...
 
Modern Application Development for the Enterprise
Modern Application Development for the EnterpriseModern Application Development for the Enterprise
Modern Application Development for the Enterprise
 
What's New in Oracle SQL Developer for 2018
What's New in Oracle SQL Developer for 2018What's New in Oracle SQL Developer for 2018
What's New in Oracle SQL Developer for 2018
 

Plus de Marta Rauch

Delighting mobile customers with content for apps, videos, and a social media...
Delighting mobile customers with content for apps, videos, and a social media...Delighting mobile customers with content for apps, videos, and a social media...
Delighting mobile customers with content for apps, videos, and a social media...Marta Rauch
 
Mobile Trends and Innovations
Mobile Trends and InnovationsMobile Trends and Innovations
Mobile Trends and InnovationsMarta Rauch
 
Rauch delighting mobile customers with content for apps, videos, and a social...
Rauch delighting mobile customers with content for apps, videos, and a social...Rauch delighting mobile customers with content for apps, videos, and a social...
Rauch delighting mobile customers with content for apps, videos, and a social...Marta Rauch
 
Google Glass and Augmented Reality - tools for your content strategy tool kit
Google Glass and Augmented Reality - tools for your content strategy tool kitGoogle Glass and Augmented Reality - tools for your content strategy tool kit
Google Glass and Augmented Reality - tools for your content strategy tool kitMarta Rauch
 
Wearables and Google Glass
Wearables and Google GlassWearables and Google Glass
Wearables and Google GlassMarta Rauch
 
Augmented Reality and Google Glass
Augmented Reality and Google GlassAugmented Reality and Google Glass
Augmented Reality and Google GlassMarta Rauch
 
Google Glass is Here! What's Real, What's Hype, and What's Just Cool
 Google Glass is Here! What's Real, What's Hype, and What's Just Cool Google Glass is Here! What's Real, What's Hype, and What's Just Cool
Google Glass is Here! What's Real, What's Hype, and What's Just CoolMarta Rauch
 
Using a Gamification Framework to Start Your Own Gamification Project
Using a Gamification Framework to Start Your Own Gamification ProjectUsing a Gamification Framework to Start Your Own Gamification Project
Using a Gamification Framework to Start Your Own Gamification ProjectMarta Rauch
 
Augmented Reality and Google Glass
Augmented Reality and Google GlassAugmented Reality and Google Glass
Augmented Reality and Google GlassMarta Rauch
 
Game On: Creating User Assistance for Gamified Products
Game On: Creating User Assistance for Gamified ProductsGame On: Creating User Assistance for Gamified Products
Game On: Creating User Assistance for Gamified ProductsMarta Rauch
 
Mobile Content Prototyping - Jump Start Your Mobile Project
Mobile Content Prototyping - Jump Start Your Mobile ProjectMobile Content Prototyping - Jump Start Your Mobile Project
Mobile Content Prototyping - Jump Start Your Mobile ProjectMarta Rauch
 
Gamification is Here: Build a Winning Plan!
Gamification is Here: Build a Winning Plan!Gamification is Here: Build a Winning Plan!
Gamification is Here: Build a Winning Plan!Marta Rauch
 
Mobile Usability Guidelines to Implement Now
Mobile Usability Guidelines to Implement NowMobile Usability Guidelines to Implement Now
Mobile Usability Guidelines to Implement NowMarta Rauch
 
Enterprise Gamification
Enterprise GamificationEnterprise Gamification
Enterprise GamificationMarta Rauch
 
Mobile Usability Guidelines to Implement Now
Mobile Usability Guidelines to Implement NowMobile Usability Guidelines to Implement Now
Mobile Usability Guidelines to Implement NowMarta Rauch
 
Innovations in User Assistance
Innovations in User AssistanceInnovations in User Assistance
Innovations in User AssistanceMarta Rauch
 
12 Key Mobile Usability Guidelines to Implement Now
12 Key Mobile Usability Guidelines to Implement Now12 Key Mobile Usability Guidelines to Implement Now
12 Key Mobile Usability Guidelines to Implement NowMarta Rauch
 
Rauch Lava Con Mobile Usability 2011
Rauch Lava Con Mobile Usability 2011Rauch Lava Con Mobile Usability 2011
Rauch Lava Con Mobile Usability 2011Marta Rauch
 
7 Key Mobile Usability Guidelines to Implement Now, LavaCon 2011, Marta Rauch
7 Key Mobile Usability Guidelines to Implement Now, LavaCon 2011, Marta Rauch7 Key Mobile Usability Guidelines to Implement Now, LavaCon 2011, Marta Rauch
7 Key Mobile Usability Guidelines to Implement Now, LavaCon 2011, Marta RauchMarta Rauch
 

Plus de Marta Rauch (19)

Delighting mobile customers with content for apps, videos, and a social media...
Delighting mobile customers with content for apps, videos, and a social media...Delighting mobile customers with content for apps, videos, and a social media...
Delighting mobile customers with content for apps, videos, and a social media...
 
Mobile Trends and Innovations
Mobile Trends and InnovationsMobile Trends and Innovations
Mobile Trends and Innovations
 
Rauch delighting mobile customers with content for apps, videos, and a social...
Rauch delighting mobile customers with content for apps, videos, and a social...Rauch delighting mobile customers with content for apps, videos, and a social...
Rauch delighting mobile customers with content for apps, videos, and a social...
 
Google Glass and Augmented Reality - tools for your content strategy tool kit
Google Glass and Augmented Reality - tools for your content strategy tool kitGoogle Glass and Augmented Reality - tools for your content strategy tool kit
Google Glass and Augmented Reality - tools for your content strategy tool kit
 
Wearables and Google Glass
Wearables and Google GlassWearables and Google Glass
Wearables and Google Glass
 
Augmented Reality and Google Glass
Augmented Reality and Google GlassAugmented Reality and Google Glass
Augmented Reality and Google Glass
 
Google Glass is Here! What's Real, What's Hype, and What's Just Cool
 Google Glass is Here! What's Real, What's Hype, and What's Just Cool Google Glass is Here! What's Real, What's Hype, and What's Just Cool
Google Glass is Here! What's Real, What's Hype, and What's Just Cool
 
Using a Gamification Framework to Start Your Own Gamification Project
Using a Gamification Framework to Start Your Own Gamification ProjectUsing a Gamification Framework to Start Your Own Gamification Project
Using a Gamification Framework to Start Your Own Gamification Project
 
Augmented Reality and Google Glass
Augmented Reality and Google GlassAugmented Reality and Google Glass
Augmented Reality and Google Glass
 
Game On: Creating User Assistance for Gamified Products
Game On: Creating User Assistance for Gamified ProductsGame On: Creating User Assistance for Gamified Products
Game On: Creating User Assistance for Gamified Products
 
Mobile Content Prototyping - Jump Start Your Mobile Project
Mobile Content Prototyping - Jump Start Your Mobile ProjectMobile Content Prototyping - Jump Start Your Mobile Project
Mobile Content Prototyping - Jump Start Your Mobile Project
 
Gamification is Here: Build a Winning Plan!
Gamification is Here: Build a Winning Plan!Gamification is Here: Build a Winning Plan!
Gamification is Here: Build a Winning Plan!
 
Mobile Usability Guidelines to Implement Now
Mobile Usability Guidelines to Implement NowMobile Usability Guidelines to Implement Now
Mobile Usability Guidelines to Implement Now
 
Enterprise Gamification
Enterprise GamificationEnterprise Gamification
Enterprise Gamification
 
Mobile Usability Guidelines to Implement Now
Mobile Usability Guidelines to Implement NowMobile Usability Guidelines to Implement Now
Mobile Usability Guidelines to Implement Now
 
Innovations in User Assistance
Innovations in User AssistanceInnovations in User Assistance
Innovations in User Assistance
 
12 Key Mobile Usability Guidelines to Implement Now
12 Key Mobile Usability Guidelines to Implement Now12 Key Mobile Usability Guidelines to Implement Now
12 Key Mobile Usability Guidelines to Implement Now
 
Rauch Lava Con Mobile Usability 2011
Rauch Lava Con Mobile Usability 2011Rauch Lava Con Mobile Usability 2011
Rauch Lava Con Mobile Usability 2011
 
7 Key Mobile Usability Guidelines to Implement Now, LavaCon 2011, Marta Rauch
7 Key Mobile Usability Guidelines to Implement Now, LavaCon 2011, Marta Rauch7 Key Mobile Usability Guidelines to Implement Now, LavaCon 2011, Marta Rauch
7 Key Mobile Usability Guidelines to Implement Now, LavaCon 2011, Marta Rauch
 

Dernier

COMPUTER 10: Lesson 7 - File Storage and Online Collaboration
COMPUTER 10: Lesson 7 - File Storage and Online CollaborationCOMPUTER 10: Lesson 7 - File Storage and Online Collaboration
COMPUTER 10: Lesson 7 - File Storage and Online Collaborationbruanjhuli
 
Introduction to Quantum Computing
Introduction to Quantum ComputingIntroduction to Quantum Computing
Introduction to Quantum ComputingGDSC PJATK
 
The Data Metaverse: Unpacking the Roles, Use Cases, and Tech Trends in Data a...
The Data Metaverse: Unpacking the Roles, Use Cases, and Tech Trends in Data a...The Data Metaverse: Unpacking the Roles, Use Cases, and Tech Trends in Data a...
The Data Metaverse: Unpacking the Roles, Use Cases, and Tech Trends in Data a...Aggregage
 
Videogame localization & technology_ how to enhance the power of translation.pdf
Videogame localization & technology_ how to enhance the power of translation.pdfVideogame localization & technology_ how to enhance the power of translation.pdf
Videogame localization & technology_ how to enhance the power of translation.pdfinfogdgmi
 
Things you didn't know you can use in your Salesforce
Things you didn't know you can use in your SalesforceThings you didn't know you can use in your Salesforce
Things you didn't know you can use in your SalesforceMartin Humpolec
 
Linked Data in Production: Moving Beyond Ontologies
Linked Data in Production: Moving Beyond OntologiesLinked Data in Production: Moving Beyond Ontologies
Linked Data in Production: Moving Beyond OntologiesDavid Newbury
 
IESVE Software for Florida Code Compliance Using ASHRAE 90.1-2019
IESVE Software for Florida Code Compliance Using ASHRAE 90.1-2019IESVE Software for Florida Code Compliance Using ASHRAE 90.1-2019
IESVE Software for Florida Code Compliance Using ASHRAE 90.1-2019IES VE
 
Bird eye's view on Camunda open source ecosystem
Bird eye's view on Camunda open source ecosystemBird eye's view on Camunda open source ecosystem
Bird eye's view on Camunda open source ecosystemAsko Soukka
 
UiPath Studio Web workshop series - Day 6
UiPath Studio Web workshop series - Day 6UiPath Studio Web workshop series - Day 6
UiPath Studio Web workshop series - Day 6DianaGray10
 
Connector Corner: Extending LLM automation use cases with UiPath GenAI connec...
Connector Corner: Extending LLM automation use cases with UiPath GenAI connec...Connector Corner: Extending LLM automation use cases with UiPath GenAI connec...
Connector Corner: Extending LLM automation use cases with UiPath GenAI connec...DianaGray10
 
Spring24-Release Overview - Wellingtion User Group-1.pdf
Spring24-Release Overview - Wellingtion User Group-1.pdfSpring24-Release Overview - Wellingtion User Group-1.pdf
Spring24-Release Overview - Wellingtion User Group-1.pdfAnna Loughnan Colquhoun
 
RAG Patterns and Vector Search in Generative AI
RAG Patterns and Vector Search in Generative AIRAG Patterns and Vector Search in Generative AI
RAG Patterns and Vector Search in Generative AIUdaiappa Ramachandran
 
Empowering Africa's Next Generation: The AI Leadership Blueprint
Empowering Africa's Next Generation: The AI Leadership BlueprintEmpowering Africa's Next Generation: The AI Leadership Blueprint
Empowering Africa's Next Generation: The AI Leadership BlueprintMahmoud Rabie
 
Anypoint Code Builder , Google Pub sub connector and MuleSoft RPA
Anypoint Code Builder , Google Pub sub connector and MuleSoft RPAAnypoint Code Builder , Google Pub sub connector and MuleSoft RPA
Anypoint Code Builder , Google Pub sub connector and MuleSoft RPAshyamraj55
 
UiPath Platform: The Backend Engine Powering Your Automation - Session 1
UiPath Platform: The Backend Engine Powering Your Automation - Session 1UiPath Platform: The Backend Engine Powering Your Automation - Session 1
UiPath Platform: The Backend Engine Powering Your Automation - Session 1DianaGray10
 
IaC & GitOps in a Nutshell - a FridayInANuthshell Episode.pdf
IaC & GitOps in a Nutshell - a FridayInANuthshell Episode.pdfIaC & GitOps in a Nutshell - a FridayInANuthshell Episode.pdf
IaC & GitOps in a Nutshell - a FridayInANuthshell Episode.pdfDaniel Santiago Silva Capera
 
Computer 10: Lesson 10 - Online Crimes and Hazards
Computer 10: Lesson 10 - Online Crimes and HazardsComputer 10: Lesson 10 - Online Crimes and Hazards
Computer 10: Lesson 10 - Online Crimes and HazardsSeth Reyes
 
NIST Cybersecurity Framework (CSF) 2.0 Workshop
NIST Cybersecurity Framework (CSF) 2.0 WorkshopNIST Cybersecurity Framework (CSF) 2.0 Workshop
NIST Cybersecurity Framework (CSF) 2.0 WorkshopBachir Benyammi
 
UWB Technology for Enhanced Indoor and Outdoor Positioning in Physiological M...
UWB Technology for Enhanced Indoor and Outdoor Positioning in Physiological M...UWB Technology for Enhanced Indoor and Outdoor Positioning in Physiological M...
UWB Technology for Enhanced Indoor and Outdoor Positioning in Physiological M...UbiTrack UK
 
GenAI and AI GCC State of AI_Object Automation Inc
GenAI and AI GCC State of AI_Object Automation IncGenAI and AI GCC State of AI_Object Automation Inc
GenAI and AI GCC State of AI_Object Automation IncObject Automation
 

Dernier (20)

COMPUTER 10: Lesson 7 - File Storage and Online Collaboration
COMPUTER 10: Lesson 7 - File Storage and Online CollaborationCOMPUTER 10: Lesson 7 - File Storage and Online Collaboration
COMPUTER 10: Lesson 7 - File Storage and Online Collaboration
 
Introduction to Quantum Computing
Introduction to Quantum ComputingIntroduction to Quantum Computing
Introduction to Quantum Computing
 
The Data Metaverse: Unpacking the Roles, Use Cases, and Tech Trends in Data a...
The Data Metaverse: Unpacking the Roles, Use Cases, and Tech Trends in Data a...The Data Metaverse: Unpacking the Roles, Use Cases, and Tech Trends in Data a...
The Data Metaverse: Unpacking the Roles, Use Cases, and Tech Trends in Data a...
 
Videogame localization & technology_ how to enhance the power of translation.pdf
Videogame localization & technology_ how to enhance the power of translation.pdfVideogame localization & technology_ how to enhance the power of translation.pdf
Videogame localization & technology_ how to enhance the power of translation.pdf
 
Things you didn't know you can use in your Salesforce
Things you didn't know you can use in your SalesforceThings you didn't know you can use in your Salesforce
Things you didn't know you can use in your Salesforce
 
Linked Data in Production: Moving Beyond Ontologies
Linked Data in Production: Moving Beyond OntologiesLinked Data in Production: Moving Beyond Ontologies
Linked Data in Production: Moving Beyond Ontologies
 
IESVE Software for Florida Code Compliance Using ASHRAE 90.1-2019
IESVE Software for Florida Code Compliance Using ASHRAE 90.1-2019IESVE Software for Florida Code Compliance Using ASHRAE 90.1-2019
IESVE Software for Florida Code Compliance Using ASHRAE 90.1-2019
 
Bird eye's view on Camunda open source ecosystem
Bird eye's view on Camunda open source ecosystemBird eye's view on Camunda open source ecosystem
Bird eye's view on Camunda open source ecosystem
 
UiPath Studio Web workshop series - Day 6
UiPath Studio Web workshop series - Day 6UiPath Studio Web workshop series - Day 6
UiPath Studio Web workshop series - Day 6
 
Connector Corner: Extending LLM automation use cases with UiPath GenAI connec...
Connector Corner: Extending LLM automation use cases with UiPath GenAI connec...Connector Corner: Extending LLM automation use cases with UiPath GenAI connec...
Connector Corner: Extending LLM automation use cases with UiPath GenAI connec...
 
Spring24-Release Overview - Wellingtion User Group-1.pdf
Spring24-Release Overview - Wellingtion User Group-1.pdfSpring24-Release Overview - Wellingtion User Group-1.pdf
Spring24-Release Overview - Wellingtion User Group-1.pdf
 
RAG Patterns and Vector Search in Generative AI
RAG Patterns and Vector Search in Generative AIRAG Patterns and Vector Search in Generative AI
RAG Patterns and Vector Search in Generative AI
 
Empowering Africa's Next Generation: The AI Leadership Blueprint
Empowering Africa's Next Generation: The AI Leadership BlueprintEmpowering Africa's Next Generation: The AI Leadership Blueprint
Empowering Africa's Next Generation: The AI Leadership Blueprint
 
Anypoint Code Builder , Google Pub sub connector and MuleSoft RPA
Anypoint Code Builder , Google Pub sub connector and MuleSoft RPAAnypoint Code Builder , Google Pub sub connector and MuleSoft RPA
Anypoint Code Builder , Google Pub sub connector and MuleSoft RPA
 
UiPath Platform: The Backend Engine Powering Your Automation - Session 1
UiPath Platform: The Backend Engine Powering Your Automation - Session 1UiPath Platform: The Backend Engine Powering Your Automation - Session 1
UiPath Platform: The Backend Engine Powering Your Automation - Session 1
 
IaC & GitOps in a Nutshell - a FridayInANuthshell Episode.pdf
IaC & GitOps in a Nutshell - a FridayInANuthshell Episode.pdfIaC & GitOps in a Nutshell - a FridayInANuthshell Episode.pdf
IaC & GitOps in a Nutshell - a FridayInANuthshell Episode.pdf
 
Computer 10: Lesson 10 - Online Crimes and Hazards
Computer 10: Lesson 10 - Online Crimes and HazardsComputer 10: Lesson 10 - Online Crimes and Hazards
Computer 10: Lesson 10 - Online Crimes and Hazards
 
NIST Cybersecurity Framework (CSF) 2.0 Workshop
NIST Cybersecurity Framework (CSF) 2.0 WorkshopNIST Cybersecurity Framework (CSF) 2.0 Workshop
NIST Cybersecurity Framework (CSF) 2.0 Workshop
 
UWB Technology for Enhanced Indoor and Outdoor Positioning in Physiological M...
UWB Technology for Enhanced Indoor and Outdoor Positioning in Physiological M...UWB Technology for Enhanced Indoor and Outdoor Positioning in Physiological M...
UWB Technology for Enhanced Indoor and Outdoor Positioning in Physiological M...
 
GenAI and AI GCC State of AI_Object Automation Inc
GenAI and AI GCC State of AI_Object Automation IncGenAI and AI GCC State of AI_Object Automation Inc
GenAI and AI GCC State of AI_Object Automation Inc
 

Boost Your Content Strategy for REST APIs

  • 1. Copyright © 2015, Oracle and/or its affiliates. All rights reserved. | Boost Your Content Strategy for REST APIs Marta Rauch @martarauch Information Development World October 1, 2015
  • 2. Copyright © 2015, Oracle and/or its affiliates. All rights reserved. | Safe Harbor Statement The following is intended to outline our general product direction. It is intended for information purposes only, and may not be incorporated into any contract. It is not a commitment to deliver any material, code, or functionality, and should not be relied upon in making purchasing decisions. The development, release, and timing of any features or functionality described for Oracle’s products remains at the sole discretion of Oracle. 2
  • 3. Copyright © 2015, Oracle and/or its affiliates. All rights reserved. | What we’ll look at Importance of REST APIs Best practices for REST API content Oracle REST APIs Learn more 1 2 3 33/3/2015 4
  • 4. Copyright © 2015, Oracle and/or its affiliates. All rights reserved. | Importance of REST APIs
  • 5. Copyright © 2015, Oracle and/or its affiliates. All rights reserved. | • Growing rapidly, industry standard • Fast, scalable, reliable • Great for mobile, wearables, IoT, analytics, SEO REST = REpresentational State Transfer An architecture for client-server web communication 5https://en.wikipedia.org/wiki/Representational_state_transfer Web Technologies, APIs, SOAP, REST - 2014
  • 6. Copyright © 2015, Oracle and/or its affiliates. All rights reserved. | Examples: • Cloud services • Mobile apps • Internet of Things (IoT) API = Application Programming Interface Lets products and services communicate with each other 6 http://medianetwork.oracle.com/video/player/3630043914001
  • 7. Copyright © 2015, Oracle and/or its affiliates. All rights reserved. | APIs are growing quickly 7http://www.programmableweb.com/api-research Programmable Web http://www.programmableweb.com/api-research
  • 8. Copyright © 2015, Oracle and/or its affiliates. All rights reserved. | Finance and Enterprise are the fastest growing API categories 8 Programmable Web http://www.programmableweb.com/api-research
  • 9. Copyright © 2015, Oracle and/or its affiliates. All rights reserved. | of new APIs are REST APIs 90% 9 http://blog.soa.com/raml-birth-api-description- language-fit-enterprise/
  • 10. Copyright © 2015, Oracle and/or its affiliates. All rights reserved. | Best Practices for REST API content
  • 11. Copyright © 2015, Oracle and/or its affiliates. All rights reserved. | Get developers started quickly Include useful reference information Provide sample code Provide a list of REST endpoints Represent resources with a description language Provide a modern, usable UX Content for REST APIs
  • 12. Copyright © 2015, Oracle and/or its affiliates. All rights reserved. | Get developers started quickly Why use this API Base URL Get an API key Authentication Error handling HTTP status codes Scenarios, use cases 12 Peter Gruenbaum founder of SDK Bridge Web API Documentation Best Practices The Five Biggest API Doc Mistakes and How To Avoid Them Survey of SDK Documentation Explaining how your API uses OAuth REST API for Oracle Java Cloud Service: http://docs.oracle.com/cloud/latest/jcs_gs/JSRMR/
  • 13. Copyright © 2015, Oracle and/or its affiliates. All rights reserved. | Name Method GET, POST, PUT, DELETE… URL structure Overview Parameters Descriptions Remarks Examples REST endpoints 13 Peter Gruenbaum founder of SDK Bridge Web API Documentation Best Practices Irene Ros, REST API Documentation Best practices for API docs, Andrya Feinberg Include useful reference information REST API for Oracle Java Cloud Service: http://docs.oracle.com/cloud/latest/jcs_gs/JSRMR/
  • 14. Copyright © 2015, Oracle and/or its affiliates. All rights reserved. | Group topics into categories 14 Makes larger API docs more readable REST API for Oracle Java Cloud Service: http://docs.oracle.com/cloud/latest/jcs_gs/JSRMR/
  • 15. Copyright © 2015, Oracle and/or its affiliates. All rights reserved. | Example requests, responses, use cases In the programming languages that your customers use Test code samples 15 API Explorers, by Sarah Maddox Learning how developers think, by Joe Malin A coder’s guide to writing API documentation Code Samples by Tom Johnson Documenting REST APIs, Jody Bleyle Jennifer Rondeau Provide sample code REST API for Oracle Java Cloud Service: http://docs.oracle.com/cloud/latest/jcs_gs/JSRMR/
  • 16. Copyright © 2015, Oracle and/or its affiliates. All rights reserved. | Example: Sample Code 16 Helps developers understand real-world applications REST API for Oracle Java Cloud Service: http://docs.oracle.com/cloud/latest/jcs_gs/JSRMR/
  • 17. Copyright © 2015, Oracle and/or its affiliates. All rights reserved. | Provide quick access to request and response 17 A tabbed UI improves usability REST API for Oracle Java Cloud Service: http://docs.oracle.com/cloud/latest/jcs_gs/JSRMR/
  • 18. Copyright © 2015, Oracle and/or its affiliates. All rights reserved. | Example: Request 18 REST API for Oracle Java Cloud Service: http://docs.oracle.com/cloud/latest/jcs_gs/JSRMR/
  • 19. Copyright © 2015, Oracle and/or its affiliates. All rights reserved. | Example: Response 19 REST API for Oracle Java Cloud Service: http://docs.oracle.com/cloud/latest/jcs_gs/JSRMR/
  • 20. Copyright © 2015, Oracle and/or its affiliates. All rights reserved. | Provide a list of REST endpoints 20 REST API for Oracle Java Cloud Service: http://docs.oracle.com/cloud/latest/jcs_gs/JSRMR/ Gives developers an alternate way to access information
  • 21. Copyright © 2015, Oracle and/or its affiliates. All rights reserved. | Allows docs to be generated, automated Example frameworks Swagger Raml JSON Schema Hypermedia 21 API Description Languages: Which one is right for me? by Laura Heritage Does one API language fit an entire enterprise? By Laura Heritage Overview of RESTful API Description Languages Represent resources with an API description language https://github.com/swagger-api/swagger- spec/blob/master/examples/v2.0/json/petstore-simple.json
  • 22. Copyright © 2015, Oracle and/or its affiliates. All rights reserved. | 22 Peter Gruenbaum founder of SDK Bridge Web API Documentation Best Practices Automating REST API documentation Provide a modern, usable UX REST API for Oracle Java Cloud Service: http://docs.oracle.com/cloud/latest/jcs_gs/JSRMR/ Interactive web UI enables quick access to resources and examples
  • 23. Copyright © 2015, Oracle and/or its affiliates. All rights reserved. | Get developers started quickly Include useful reference information Provide sample code Provide a list of REST endpoints Represent resources with a description language Provide a modern, usable UX Content for REST APIs
  • 24. Copyright © 2015, Oracle and/or its affiliates. All rights reserved. | Get developers started quickly Include useful reference information Provide sample code Provide a list of REST endpoints Represent resources with a description language Provide a modern, usable UX Content for REST APIs
  • 25. Copyright © 2015, Oracle and/or its affiliates. All rights reserved. | Oracle REST APIs
  • 26. Copyright © 2015, Oracle and/or its affiliates. All rights reserved. | API Documentation Generation To auto-generate API resource reference for docs, development teams • Include required information in the API description for each resource • Adopt one of the API description frameworks recommended to Oracle teams • Use a REST Publishing app to register and publish APIs Swagger RAML API docs JSON Schema Hypermedia Publishing app converts to HTML from REST templates Canonical description
  • 27. Copyright © 2015, Oracle and/or its affiliates. All rights reserved. | 27 Product Build Systems in DEV Environments REST Publishing App Oracle Authoring Systems
  • 28. Copyright © 2015, Oracle and/or its affiliates. All rights reserved. | Swagger and Raml http://swagger.io/ http://swagger.io/specification/ http://raml.org/ http://raml.org/spec.html
  • 29. Copyright © 2015, Oracle and/or its affiliates. All rights reserved. | Sample REST API docs REST APIs for Oracle Mobile Cloud Service https://docs.oracle.com/cloud/latest/mobilecs_gs/MCSRA/ REST APIs for Oracle Social Data and Insight Cloud Service http://docs.oracle.com/cloud/latest/datacs_common/RRDAT/ REST APIs for Oracle Java Cloud Service https://docs.oracle.com/cloud/latest/jcs_gs/JSRMR/
  • 30. Copyright © 2015, Oracle and/or its affiliates. All rights reserved. | Learn More
  • 31. Copyright © 2015, Oracle and/or its affiliates. All rights reserved. | Peter Gruenbaum, SDK Bridge: API Documentation 1: JSON and XML for Technical Writers http://sdkbridge.com/online-courses/ API Documentation 2: REST for Writers http://sdkbridge.com/online-courses/ Tom Johnson’s API doc posts http://idratherbewriting.com/category/api-documentation/ and online class http://idratherbewriting.com/docapis_course_overview/ Examples from REST API for Oracle Java Cloud Service: http://docs.oracle.com/cloud/latest/jcs_gs/JSRMR/ STC Intercom API issue http://intercom.stc.org/magazine/september-2014/features-september-2014/ How do you break into API documentation? http://intercom.stc.org/2014/09/how-do-you-break-into-api-documentation/ Lessons learned as a novice API writer http://intercom.stc.org/2014/09/lessons-learned-as-a-novice-api-writer/ How to write helpful code samples http://intercom.stc.org/2014/09/how-to-write-helpful-code-samples/ Sarah Maddox, Intro to API technical writing http://www.slideshare.net/sarahmaddox/api-technical-writing Marta Rauch’s API Pinterest posts https://www.pinterest.com/martarauch/apis/ Learn API technical writing https://www.udemy.com/api-documentation-1-json-and-xml/?couponCode=apidoc Learn APIs with Codecademy http://www.codecademy.com/blog/52-learn-apis-with-codecademy Get started, take a class
  • 32. Copyright © 2015, Oracle and/or its affiliates. All rights reserved. | STC webinar API series – Sarah Maddox Intro to APIs, Joe Malin Helping the Code tell the Story Web API Documentation Best Practices by Peter Gruenbaum Documenting your API by Irene Ros Sarah Maddox API posts Documenting REST APIs by Jody Bleyle and Jennifer Rondeau The Five Biggest API Mistakes and how to Avoid Them by Peter Gruenbaum Survey on Documentation by Peter Gruenbaum Good Sample Code by Peter Gruenbaum Creating code samples for API/SDK documentation by Tom Johnson Automating REST API documentation by Tom Johnson and Peter Gruenbaum API Description Languages: Which one is right for me? by Laura Heritage Does one API language fit an entire enterprise? By Laura Heritage REST API documentation Raml: The birth of an API description language fit for enterprise How APIs can enable IDEs Helpful information
  • 33. Copyright © 2015, Oracle and/or its affiliates. All rights reserved. | Get developers started quickly Include useful reference information Provide sample code Provide a list of REST endpoints Represent resources with a description language Provide a modern, usable UX Content for REST APIs
  • 34. Copyright © 2015, Oracle and/or its affiliates. All rights reserved. | What we looked at Importance of REST APIs Best practices for REST API content Oracle REST APIs Learn more 1 2 3 34 4
  • 35. Copyright © 2015, Oracle and/or its affiliates. All rights reserved. | • @martarauch • Marta Rauch • +Marta Rauch • Marta Rauch • Marta Rauch Connect with me! Thank You!
  • 36. Copyright © 2015, Oracle and/or its affiliates. All rights reserved. | Marta Rauch works in a development team at Oracle, where she architects and leads mobile, cloud, and REST API projects. She works on REST API guides and integration guides, provides input to corporate REST API standards, and participates with a team that develops a new REST API interface. She also enjoys participating in design jams and developer challenges for mobile, augmented reality, beacons, Internet of Things, data visualization, and wearable technology. A frequent presenter for conferences and webinars, Marta has published articles for IEEE, HCII, STC, and CIDM Best Practices. She contributed information to Developing User Assistance for Mobile Apps, by Joe Welinske, and her augmented reality topic appears in The Language of Content Strategy by Rahel Bailie and Scott Abel. An STC Associate Fellow, Marta has received 15 awards for her projects at the regional and international level. She is VP of the Silicon Valley chapter and a member of the Nominating Committee. She is Tools & Development track manager for Summit 2016 proposals, and judges International Summit Awards. Marta has a degree from Stanford University and certificates from Notre Dame De Namur and University of California. About the speaker @martarauch
  • 37. Copyright © 2015, Oracle and/or its affiliates. All rights reserved. | Safe Harbor Statement The preceding is intended to outline our general product direction. It is intended for information purposes only, and may not be incorporated into any contract. It is not a commitment to deliver any material, code, or functionality, and should not be relied upon in making purchasing decisions. The development, release, and timing of any features or functionality described for Oracle’s products remains at the sole discretion of Oracle. 37
  • 38. Copyright © 2015, Oracle and/or its affiliates. All rights reserved. | 38