• Home
  • About
  • Publication Contributions
  • Mindmap Index
  • API Platform

Phil (aka MP3Monster)'s Blog

~ from Technology to Music

Phil (aka MP3Monster)'s Blog

Tag Archives: “Open API”

ODC Appreciation Day : Apiary Editor

10 Tuesday Oct 2017

Posted by mp3monster in General, Oracle, Technology

≈ Leave a comment

Tags

"Open API", apiary, apiary.io, APIBlueprint, editor, ODC, Swagger

This post is my contribution to the Oracle Developer Community (ODC) Appreciation Day. The idea of the event is best explained by Oracle Base – go here.

The Apiary Editor has to count as a pretty new entry into the possible features that could be considered with Apiary only coming into the Oracle family in the last year. Apiary as a solution provides a platform by which modern REST based APIs can be designed, documented and simulated. Apiary supports the API First design philosophy (more here) using API Blueprint notation or Swagger (now known as Open API).

The feature I want to focus on is the Apiary Editor itself (shown below), particularly when working with the API Blueprint.  The beauty of the solution is that as the documentation or API syntax is edited in the editing side (left)  the API definition/documentation immediately appears on the presentation side of the editor  (right) making it easy both see the technical specificastion and how the information is initially presented to a potential API user. This makes it really easy to understand the clarity of what is being communicated which is one of the important aspects of an API definition and API first.

Whilst Agile development states ‘prefer working code over documentation’ this provides agility as you can develop the API definition and allow people to develop against the contract we can still easily deliver quality API descriptions with sufficient information to make it understandable to a 3rd party.

Oracle Ace

TOGAF 9

API Platform Book

Oracle Cloud Integration Book

Categories

  • App Ideas
  • Books
    • Book Reviews
    • Oracle Press
    • Packt
  • Enterprise architecture
  • General
    • economy
    • LinkedIn
    • Website
  • Music
    • Music Resources
    • Music Reviews
  • Photography
  • Technology
    • APIs & microservices
    • chatbots
    • Cloud
    • Dev Meetup
    • development
    • mindmap
    • OMESA
    • Oracle
      • API Platform CS
      • ICS
      • ITSO & OEAF
      • Java Cloud
      • NodeJS Cloud
    • TOGAF
    • UKOUG
  • xxRetired

Twitter

  • UKOUG Midlands Tech Summit blog.mp3monster.org/2019/02/20/uko… https://t.co/CFQ3PT6vW1Next Tweet: 13 hours ago
  • Whilst a lot of things about organizational and individual effectivness are well known and common sense, it is inte… twitter.com/i/web/status/1…Next Tweet: 1 day ago
  • When working in a distributed organization, the sense of belonging needs a lot more effort lnkd.in/djnQghqNext Tweet: 1 day ago
  • An intriguing article about how people change in a work environment and challenges some assertions about how people… twitter.com/i/web/status/1…Next Tweet: 2 days ago
  • What is really meant and expected when we talking about Hybrid IT? lnkd.in/dQ8_E6HNext Tweet: 2 days ago
Follow @mp3monster

OraWorld

OraWorld

Oracle Scene

Enter your email address to subscribe to this blog and receive notifications of new posts by email.

Join 453 other followers

Monster's Other Web Content

  • All My Links
  • Amazon Author entry
  • API Platform
  • Dev Meetup (co-managed)
  • ICS Book Website
  • Mindmaps
  • Monster's Photos
  • my Capgemini Profile
  • Oracle Community Directory
  • Packt Author Bio

RSS

RSS Feed RSS - Posts

RSS Feed RSS - Comments

Calendar

February 2019
M T W T F S S
« Jan    
 123
45678910
11121314151617
18192021222324
25262728  

Other Pages

  • About
    • Presenting Activities
  • API Platform
    • API Useful Resources
  • Mindmap Index
  • Publication Contributions

Oracle Dev Meetup London

Goodreads

Flickr Pics

Tears For FearsTears For FearsTears For FearsTears For Fears
More Photos

History

Social

  • View @mp3monster’s profile on Twitter
Follow Phil (aka MP3Monster)'s Blog on WordPress.com

Tags

6 Music Aaron Woody AIA album Ansible API apiary API Platform app applications BBC Big Data blog book books camel Capgemini cd CEP Cloud code concert conference data Design development download ebook enterprise free fusion Good Morning Nantwich Groovy Helidon ICS integration ITSO java JBoss jBPM JDeveloper London Luis Weir meetup Microservices mindmap MP3 Music OOW Oracle Oracle Press OTN PaaS Packt Packt Publishing Patterns Phill Jupitus PIP playlist podcast promotion Puppet reading Redhat release review Security SeeWhy SOA SOA Suite software Technology TOGAF UKOUG video

Blog at WordPress.com.

Cancel
Privacy & Cookies: This site uses cookies. By continuing to use this website, you agree to their use.
To find out more, including how to control cookies, see here: Our Cookie Policy