{"id":2355,"date":"2021-10-18T10:00:00","date_gmt":"2021-10-18T14:00:00","guid":{"rendered":"https:\/\/michaelrowe01.com\/?p=2355"},"modified":"2022-12-15T06:46:02","modified_gmt":"2022-12-15T11:46:02","slug":"apis-and-open-development","status":"publish","type":"post","link":"https:\/\/michaelrowe01.com\/index.php\/uncategorized\/apis-and-open-development\/","title":{"rendered":"API\u2019s and Open Development"},"content":{"rendered":"\n
\"Bunny\"
A Monday Morning Bunny<\/figcaption><\/figure>\n\n\n\n

I rarely write posts about my day job on this blog, the focus of this blog is to address my hobbies and passions.\u00a0 When those intersect with my day job I will try and post a few thoughts.\u00a0 Having said that, I recently took a new job focusing on improving the API strategy of IBM\u2019s Engineering Lifecycle Management<\/a> offering (ELM). \u00a0<\/p>\n\n\n\n

IBM ELM is a tool suite utilized by the world\u2019s most successful companies which design, develop and deliver vehicles of all kinds (Planes, Trains, and Automobiles<\/a> – and more)!\u00a0 The suite of capabilities\u00a0 was built on the idea of open development.\u00a0 The team has been developing this publicly for well over a decade, and has built an incredible community at jazz.net<\/a>.\u00a0<\/p>\n\n\n\n

The basic, underlying APIs have been exposed via a standard called OSLC (Open Services for Lifecycle Collaboration<\/a>).\u00a0 This OSLC standard is is being maintained and enhanced via Open Oasis.\u00a0<\/p>\n\n\n\n

One of the coolest things about OSLC based APIs is that they are highly discoverable at runtime when working on building integration between systems.\u00a0 In ELM, we expose many services via a \u201cRootServices\u201d document on each server. \u00a0 By parsing this document, APIs (or services) are exposed, and their definitions are exposed. \u00a0<\/p>\n\n\n\n

I\u2019ve been working on a example of how to parse this via a set of Postman examples to help new developers understand this technology.\u00a0 This example will show, how to parse a RootServices document, perform a simple OAuth1.0a authentication, and then expose the definition of a specific API and the data that must be provided to create a system artifact.\u00a0 Right now my example shows how to create a Automated Test Adapter.<\/p>\n\n\n\n

I hope to do some cleanup of my example over the next few weeks and will post it here; however, I would like to understand what other types of open API documentation people would like to see.<\/p>\n","protected":false},"excerpt":{"rendered":"

I rarely write posts about my day job on this blog, the focus of this blog is to address my hobbies and passions.\u00a0 When those intersect with my day job I will try and post a few thoughts.\u00a0 Having said that, I recently took a new job focusing on improving the API strategy of IBM\u2019s […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_wp_convertkit_post_meta":{"form":"-1","landing_page":"0","tag":"0","restrict_content":"0"},"hide_page_title":"","_jetpack_newsletter_access":"","_jetpack_dont_email_post_to_subs":false,"_jetpack_newsletter_tier_id":0,"_jetpack_memberships_contains_paywalled_content":false,"_jetpack_feature_clip_id":0,"_jetpack_memberships_contains_paid_content":false,"footnotes":"","jetpack_publicize_message":"","jetpack_publicize_feature_enabled":true,"jetpack_social_post_already_shared":true,"jetpack_social_options":{"image_generator_settings":{"template":"highway","default_image_id":0,"font":"","enabled":false},"version":2},"jetpack_post_was_ever_published":false},"categories":[1],"tags":[],"class_list":["post-2355","post","type-post","status-publish","format-standard","hentry","category-uncategorized"],"aioseo_notices":[],"aioseo_head":"\n\t\t\n\t\n\t\n\t\n\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t