Documenting APIs on the Oracle API Platform by Phil Wilkins

image

The last week or two I have been working on a new API Platform utility to add to my existing tools (see here). This tool addresses the question of generating documentation.  Much as been said about API documentation and the quality of it, check out these articles :

If you look at these articles and others, there are some common themes, which are:

  • Document the URI / payload
  • Describe error handling
  • Describe contracts such as how many API calls
  • How the API is authenticated

Apiary covers the first theme to a first class standard,  and you will see Apiary called out for its ability to document APIs in a lot of articles. Well written API Blueprints will cover the bulk of the second bullet. But the other points tend to fall outside of a Blueprint and fit more the API Policies and their use.

Not everyone is so commited or enjoys writing documentation. The other driver for going beyond the use of Apiary is that some organizations feel the need to have a traditional word style document to capture/define an API’s contract in detail. With the API Platform the management portal enables an API to be published into the developer portal with the Apiary definition and a markdown file for further documentation.

As you can see some of the information about the policies should be incorporated into the documentation. So how, can the gap be addressed easily. Within the policy definition is the means to provide documentation, as illustrated below. This provides an opportunity to record a more general explanation as to what and how to address that policy. Read the complete article here.

 

PaaS Partner Community

For regular information on Oracle PaaS become a member in the SOA & BPM Partner Community for registration please visit www.oracle.com/goto/emea/soa (OPN account required) If you need support with your account please contact the Oracle Partner Business Center.

clip_image003 Blog clip_image005 Twitter clip_image004 LinkedIn image[7][2][2][2] Facebook clip_image002[8][4][2][2][2] Wiki

Technorati Tags: SOA Community,Oracle SOA,Oracle BPM,OPN,Jürgen Kress

API Platform Cloud Service article series by Ankur Jain

image

A great API Management solution supports agile API development, and also makes it easy to keep an eye on KPIs covering every aspect of the API lifecycle. True hybrid API deployment – in the Cloud or on-premises – means that your API solution is modern and adaptable, all while employing the most up-to-date security protocols.

Get started with API Platform Cloud Service:

Creating an Oracle API Platform Cloud Service (CS) Instance
Service Account in Oracle API Cloud Service(CS)
Creating an API in Oracle API Platform Cloud Service (API CS)
Oracle API Physical Gateway installation and register with Oracle API CS

 

PaaS Partner Community

For regular information on Oracle PaaS become a member in the SOA & BPM Partner Community for registration please visit www.oracle.com/goto/emea/soa (OPN account required) If you need support with your account please contact the Oracle Partner Business Center.

clip_image003 Blog clip_image005 Twitter clip_image004 LinkedIn image[7][2][2][2] Facebook clip_image002[8][4][2][2][2] Wiki

Technorati Tags: SOA Community,Oracle SOA,Oracle BPM,OPN,Jürgen Kress

Oracle API Platform Cloud Service: using the Management Portal and creating an API (including some policies) by Marc Lameriks

image

At the Oracle Partner PaaS Summer Camps VII 2017 in Lisbon last year, at the end of august, I attended the API Platform Cloud Service & Integration Cloud Service bootcamp.

In a series of article’s I will give a high level overview of what you can do with Oracle API Platform Cloud Service.

At the Summer Camp a pre-built Oracle VM VirtualBox APIPCS appliance (APIPCS_17_3_3.ova) was provided to us, to be used in VirtualBox. Everything needed to run a complete demo of API Platform Cloud Service is contained within Docker containers that are staged in that appliance. The version of Oracle API Platform CS, used within the appliance, is Release 17.3.3 — August 2017.

See https://docs.oracle.com/en/cloud/paas/api-platform-cloud/whats-new/index.html to learn about the new and changed features of Oracle API Platform CS in the latest release.

In this article in the series about Oracle API Platform CS, the focus will be on the Management Portal and creating an API (including some policies) .

Be aware that the screenshot’s in this article and the examples provided, are based on a demo environment of Oracle API Platform CS and were created by using the Oracle VM VirtualBox APIPCS appliance mentioned above.

This article only covers part of the functionality of Oracle API Platform CS. For more detail I refer you to the documentation: https://cloud.oracle.com/en_US/api-platform.

Short overview of Oracle API Platform Cloud Service

Oracle API Platform Cloud Service enables companies to thrive in the digital economy by comprehensively managing the full API lifecycle from design and standardization to documenting, publishing, testing and managing APIs. These tools provide API developers, managers, and users an end-to-end platform for designing, prototyping. Through the platform, users gain the agility needed to support changing business demands and opportunities, while having clear visibility into who is using APIs for better control, security and monetization of digital assets. Read the complete article here.

 

PaaS Partner Community

For regular information on Oracle PaaS become a member in the SOA & BPM Partner Community for registration please visit www.oracle.com/goto/emea/soa (OPN account required) If you need support with your account please contact the Oracle Partner Business Center.

clip_image003 Blog clip_image005 Twitter clip_image004 LinkedIn image[7][2][2][2] Facebook clip_image002[8][4][2][2][2] Wiki

Technorati Tags: SOA Community,Oracle SOA,Oracle BPM,OPN,Jürgen Kress

Implementing Oracle API Platform Cloud Service: Design, deploy, and manage your APIs in Oracle’s new API Platform book by Luis Weir, Phil Wilkins, Sander Rensen and Andrew Bell

image

Implementing Oracle API Platform Cloud Service moves from theory to practice using the newest Oracle API management platform. This critical new platform for Oracle developers allows you to interface the complex array of services your clients expect in the modern world.

First, you’ll learn about Oracle’s new platform and get an overview of it, then you’ll see a use case showing the functionality and use of this new platform for Oracle customers. Next, you’ll see the power of Apiary and begin designing your own APIs. From there, you’ll build and run microservices and set up the Oracle API gateways.

Moving on, you’ll discover how to customize the developer portal and publish your own APIs. You’ll spend time looking at configuration management on the new platform, and implementing the Oauth 2.0 policy, as well as custom policies. The latest finance modules from Oracle will be examined, with some of the third party alternatives in sight as well.

This broad-scoped book completes your journey with a clear examination of how to transition APIs from Oracle API Management 12c to the new Oracle API Platform, so that you can step into the future confidently.

What you will learn
  • Get an overview of the Oracle API Cloud Service Platform
  • See typical use cases of the Oracle API Cloud Service Platform
  • Design your own APIs using Apiary
  • Build and run microservices
  • Set up API gateways with the new API platform from Oracle
  • Customize developer portals
  • Configuration management
  • Implement Oauth 2.0 policies
  • Implement custom policies
  • Get a policy SDK overview
  • Transition from Oracle API Management 12c to the new Oracle API platform
Who this book is for

This book is for all Oracle developers who are working or plan to work with the Oracle API Platform Cloud Service. Get the book here.

Additional Integration books are listed in our community wiki here.

PaaS Partner Community

For regular information on Oracle PaaS become a member in the SOA & BPM Partner Community for registration please visit www.oracle.com/goto/emea/soa (OPN account required) If you need support with your account please contact the Oracle Partner Business Center.

clip_image003 Blog clip_image005 Twitter clip_image004 LinkedIn image[7][2][2][2] Facebook clip_image002[8][4][2][2][2] Wiki

Technorati Tags: SOA Community,Oracle SOA,Oracle BPM,OPN,Jürgen Kress

How API control ensures integration success by Joost Volker

image

A connected enterprise drives innovation and enables organisations to deliver the superior experience that customers demand. With streamlined cloud platforms and APIs enabling simpler and faster connections at scale, businesses of all sizes can connect and extend their services while staying in total control throughout the integration lifecycle.

Previously, we’ve talked about how integration and innovation are linked. Truly innovative ideas aren’t necessarily about bringing new solutions or tools to your organisation—it’s about connecting existing systems, touchpoints, and data in new ways.

But the way businesses create and manage integration points is also going through a period of transformational innovation. Platforms have evolved to speed innovation, leverage existing investments and deliver rapid business decisions with 360-degree view.

Integration starts in the cloud

Integration has been an important part of on-premise development for some time. But in today’s business world, the cloud is taking integration to completely new levels.

In the cloud, integration tools are easier to acquire, simpler to experiment with, and can connect far more disparate services (with far less effort). Cloud platforms offer visual extension tools that can help you:

  • Get LOB professionals involved in the integration journey with intuitive user interfaces
  • Add Machine Learning and Artificial Intelligence capabilities to broaden business process automation
  • Provide multi-channel options to facilitate all possible interactions with users, process owners, and administrators.

In the cloud, it’s easier than ever to join customer-facing portals with back-end payment systems, connect HR performance data with financial reports, or perform any other common integrations across the enterprise.

Not only are cloud platforms simplifying integration and putting powerful capabilities in the hands of more organisations, they’re also helping businesses develop more advanced, truly unified integration strategies to monetise their data, services, and the connections between them.

Enter the API

In a world dominated by the fast-paced digital economy, APIs have become a popular technology to connect and extend applications. By abstracting underlying information and only exposing the information relevant to an integration, APIs have made creating secure new integrations faster and simpler, allowing disparate services to interact with each other and extend their reach.

For example, successful cloud native architectures require a strong API design to tie back into the app as a whole. Read the complete article here.

 

PaaS Partner Community

For regular information on Oracle PaaS become a member in the SOA & BPM Partner Community for registration please visit www.oracle.com/goto/emea/soa (OPN account required) If you need support with your account please contact the Oracle Partner Business Center.

clip_image003 Blog clip_image005 Twitter clip_image004 LinkedIn image[7][2][2][2] Facebook clip_image002[8][4][2][2][2] Wiki

Technorati Tags: SOA Community,Oracle SOA,Oracle BPM,OPN,Jürgen Kress

Integration Cloud – the Value Add by Niall Commiskey

image

The next iteration of our cloud based integration platform has been released recently.
Are we going to get another acronym – AIC? Let’s wait and see.

But firstly, what are the deltas between the customer managed OIC and AIC?
OIC customer managed, means what it says – you are responsible for the environment, provisioning pre-requisites etc. You are responsible for patching, DB backup/recovery etc. AIC is more like a SaaS experience, you just log in and use the stuff.

The screenshot above shows the context menu for my AIC instance. As you can see, all I can do is use it; no weblogic console login, no enterprise manager login, no ssh. I just use it, sure isn’t that why I bought it? I don’t want to manage underlying infrastructure, I just need to integration my SaaS and on-prem apps. Read the complete article here.

 

PaaS Partner Community

For regular information on Oracle PaaS become a member in the SOA & BPM Partner Community for registration please visit www.oracle.com/goto/emea/soa (OPN account required) If you need support with your account please contact the Oracle Partner Business Center.

clip_image003 Blog clip_image005 Twitter clip_image004 LinkedIn image[7][2][2][2] Facebook clip_image002[8][4][2][2][2] Wiki

Technorati Tags: SOA Community,Oracle SOA,Oracle BPM,OPN,Jürgen Kress

Bill Swales and Siddhartha Agarwal kick off and in-depth series that explores the most common journeys to the cloud

image

Watch the videos here.

 

PaaS Partner Community

For regular information on Oracle PaaS become a member in the SOA & BPM Partner Community for registration please visit www.oracle.com/goto/emea/soa (OPN account required) If you need support with your account please contact the Oracle Partner Business Center.

clip_image003 Blog clip_image005 Twitter clip_image004 LinkedIn image[7][2][2][2] Facebook clip_image002[8][4][2][2][2] Wiki

Technorati Tags: SOA Community,Oracle SOA,Oracle BPM,OPN,Jürgen Kress

New Home for Oracle PaaS and IaaS Customer Forums

image

The Oracle PaaS and IaaS customer forums have moved to Oracle Cloud Customer Connect and now include over 20 discussion forums covering a wide range of Oracle platform and infrastructure services. We encourage you to be active in these forums as a way to network with the Oracle customer community and build your reputation as an Oracle Cloud expert. Please join today.

PaaS Partner Community

For regular information on Oracle PaaS become a member in the SOA & BPM Partner Community for registration please visit www.oracle.com/goto/emea/soa (OPN account required) If you need support with your account please contact the Oracle Partner Business Center.

clip_image003 Blog clip_image005 Twitter clip_image004 LinkedIn image[7][2][2][2] Facebook clip_image002[8][4][2][2][2] Wiki

Technorati Tags: SOA Community,Oracle SOA,Oracle BPM,OPN,Jürgen Kress

Top tweets PaaS Partner Community January 2019

Januaimagery 2019 top tweets by PaaSCommunity

Send your tweets @soacommunity #PaaSCommunity and follow us at http://twitter.com/soacommunity. Make sure you share your content with the community!

SOA & BPM Partner Community

For regular information on Oracle SOA Suite become a member in the SOA & BPM Partner Community for registration please visit www.oracle.com/goto/emea/soa (OPN account required) If you need support with your account please contact the Oracle Partner Business Center.

clip_image003 Blog clip_image005 Twitter clip_image004 LinkedIn image[7][2][2][2] Facebook clip_image002[8][4][2][2][2] Wiki

Technorati Tags: twitter,SOA Community,Oracle SOA,Oracle BPM,OPN,Jürgen Kress,SOA Community twitter

Additional new content PaaS Partner Community

image

· Autonomous IT Now How will autonomous technology services alter business strategies and change the nature of IT? Companies using Oracle’s Autonomous Data Warehouse Cloud are providing some of the earliest answers. For example, for the first time ever, a businessperson who isn’t an expert in IT can order up a powerful, autonomous data warehouse and be ready to load huge amounts of data—accomplishing in minutes what might have taken a DBA days to set up. “This gives database superpowers to business people who never had it before,” says Accenture Chief Technology and Innovation Officer Paul Daugherty. Read more about how Daugherty and fellow leaders in business and tech are using autonomous IT right now.

· Municipal Open Data APIs and Low Code Development Tools: Several cities offer APIs for accessing Municipal Open Data. Learn about the kind of data that is available and about some of the tools you can use to take advantage of these incredible resources.

· Experience Oracle Cloud with $300 in Free Credits

· Report: How CFOs Can Lead the Coming Productivity Boom

· Developers: Find a Free Oracle Code Event Near You

· Microservices: Unraveling the Mystery

· Functions-as-a-Service – What SOA Should Have Been

· Running Spring Boot in a Docker container on OpenJDK, Oracle JDK, Zulu on Alpine Linux, Oracle Linux, Ubuntu

· Building Single Base-Language Chatbots with Oracle Intelligent Bots

· Continuous Integration with Apiary, Dredd, and Wercker

· Oracle MOOC: Developing Chatbots with Oracle Mobile Cloud, Enterprise

PaaS Partner Community

For regular information on Oracle PaaS become a member in the SOA & BPM Partner Community for registration please visit www.oracle.com/goto/emea/soa (OPN account required) If you need support with your account please contact the Oracle Partner Business Center.

clip_image003 Blog clip_image005 Twitter clip_image004 LinkedIn image[7][2][2][2] Facebook clip_image002[8][4][2][2][2] Wiki

Technorati Tags: SOA Community,Oracle SOA,Oracle BPM,OPN,Jürgen Kress