Over a million developers have joined DZone.
{{announcement.body}}
{{announcement.title}}

Embeddable API Tooling Discovery With JSON Home

DZone's Guide to

Embeddable API Tooling Discovery With JSON Home

JSON Home can be used for API discovery. In this article, see how one of its features describes a widget putting an API to use as part of its operation.

· Integration Zone ·
Free Resource

The new Gartner Critical Capabilities report explains how APIs and microservices enable digital leaders to deliver better B2B, open banking and mobile projects.

I have been studying JSON Home, trying to understand how it sizes up to APIs.json, and other formats I’m tracking, like Pivio. JSON Home has a number of interesting features, and I thought one of their examples was also interesting, and was relevant to my API embeddable research. In this example, JSON Home was describing a widget that was putting an API to use as part of its operation.

Here is the snippet from the JSON Home example, providing all details of how it works:

{
   "api": {
     "title": "Example API",
     "links": {
       "author": "mailto:api-admin@example.com",
       "describedBy": "https://example.com/api-docs/"
     }
   }
   "resources": {
     "tag:me@example.com,2016:widgets": {
       "href": "/widgets/"
     },
     "tag:me@example.com,2016:widget": {
       "hrefTemplate": "/widgets/{widget_id}",
       "hrefVars": {
         "widget_id": "https://example.org/param/widget"
       },
       "hints": {
         "allow": ["GET", "PUT", "DELETE", "PATCH"],
         "formats": {
           "application/json": {}
         },
         "acceptPatch": ["application/json-patch+json"],
         "acceptRanges": ["bytes"]
       }
     }
   }
 }

JSON Home seems very action oriented. Everything about the format leads you towards taking some sort of API driven action, something that makes a lot of sense when it comes to widgets and other embeddables. I could see JSON Home being used as some sort of definition for button or widget generation and building tooling, providing a machine readable definition for the embeddable tool, and what is possible with the API(s) behind.

I’ve been working towards embeddable directories and API stacks using APIs.json, providing distributed and embeddable tooling that API providers and consumers can publish anywhere. I will be spending more time thinking about how this world of API discovery can overlap with the world of API embeddables, providing not just a directory of buttons, badges, and widgets, but one that describes what is possible when you engage with any embeddable tool. I’m beginning to see JSON Home similar to how I see Postman Collections, something that is closer to runtime, or at least deploy time. Where APIs.json is much more about indexing, search, and discovery–maybe some detail about where the widgets are, or maybe more detail about what embeddable resources are available.

The new Gartner Critical Capabilities for Full Lifecycle API Management report shows how CA Technologies helps digital leaders with their B2B, open banking, and mobile initiatives. Get your copy from CA Technologies.

Topics:
integration ,api ,json api ,api discovery

Published at DZone with permission of

Opinions expressed by DZone contributors are their own.

{{ parent.title || parent.header.title}}

{{ parent.tldr }}

{{ parent.urlSource.name }}