APIs.json Blog

APIs.json Is An Index For API Operations

Posted on

As part of the latest wave of work around the APIs.json format We wanted to take some time to help folks better understand exactly what APIs.json is, and what it can do for API providers, consumers, as well as the fast moving API sector. We are working on version 0.16 of the API discovery format, and we wanted to help get the word out about some of the cool stuff that is being done with APIs.json, as well as what is possible in the future. What is APIs.json? APIs.json provides a machine readable approach that API providers can put work......read more.



Setting rel=api Into Motion With Latest APIs.json Release

Posted on

Bruno Pedro (@bpedro) who has been building APIs.json into his API Changelog service, made a pull request to the specification recently, pushing forward the link relation conversation for APIs.json. As listed in the specification, we have long intended to make APIs.json an official media type: 3.5.  Media Type It is intended that if there is sufficient traction, the media type "application/apis+json" will be   submitted to IANA as per RFC: http://tools.ietf.org/html/rfc4288 However when it came to expressing your APIs.json as a link relation, we didn't even really have a plan in our road-map, resulting in a very generic allocation of a link......read more.



Quantifying A Minimum Viable API Footprint Definition As Real APIs.json Driven Portal

Posted on

I wrote a post the other day laying out what I'd consider a minimum viable footprint for API operations. My vision of just exactly what an API is, has gone beyond just the technical, ever since I started API Evangelist back in July of 2010. Early on I saw this was more than just about the API endpoints, and documentation, code samples, and many other building blocks were essential to the success (or failure) of any API platform, area, or ecosystem. This recent post was an attempt, here in 2015, to quantify what I would consider to be a minimum......read more.



A Breakdown Of My Dream APIs.json File

Posted on

I'm continuing my work, to help people understand what APIs.json is, and the varying ways that it can be put to use. My post the other week, breaking down Fitbits APIs.json file is a good example of where to get started, and as a follow-up I wanted to help further set the bar for what a minimum viable APIs.json looks like, and today, I am going in the other direction--toward my dream APis.json file. APIs.json starts with a basic set of descriptions for who you are, the API provider. Each header of an APIs.json file gives you a handful of parameters......read more.



A Minimum Viable APIs.json File For Your APIs

Posted on

I'm continuing my work to help people understand what APIs.json is, and the varying ways that it can be put to use. My post the other day, breaking down Fitbits APIs.json file is a good example of where to get started, but I wanted to help further set the bar for a minimum viable APIs.json. APIs.json starts with a basic set of descriptions of who you are, the API provider. Each header of an APIs.json file gives you a handful of parameters for describing who you are: name - your individual or company name, who is managing the APIs.json file.......read more.



Breaking Down The Fitbit APIs.json File

Posted on

The quantified-self API Fitbit recently added an APIs.json for their domain. Their usage of APIs.json is a perfect, dead-simple, introductory example of how APIs can start putting APIs.json for their API platform. To help other providers understand, I wanted to take a look at the moving parts of Fitbits APIs.json, and to assist the conversation I labeled each part. A) The heart of an APIs.json, providing a name, description, image, and tags for API platform and collection. B) The technical details of where this APIs.json came from, which version it is, and when it was created and last modified. C)......read more.



Using APIs.json For My Microservice Navigation And Discovery

Posted on

I’m rebuilding my underlying architecture using microservices and docker containers, and the glue I’m using to bind it all together is APIs.json. I’m not just using APIs.son to deliver on discoverability for all of my services, I am also using it to navigate around my stack. Right now I only have about 10 microservices running, but I have a plan to add almost 50 in total by the time I’m done with this latest sprint. Each microservice lives as its own Github repository, within a specific organization. I give each one its own APIs.json, indexing all the elements APIs of......read more.



My Experiences Generating API Server or Client Code Using Swagger

Posted on

When you start talking about generating server or client side code for APIs, using machine readable API definition formats like Swagger or API Blueprint, many technologists feel compelled to let you know, that at some point you will hit a wall. There is only so far you can go, when using your API definition as guide for generating server-side or clienit-side code, but in my experience you can definitely save some significant time an energy, by auto-generating code using Swagger definitions. I just finished re-designing 15 APIs that support the core of API Evangelist, and to support the work I......read more.



REST API Design: Bridging What We Have, To The Future, By Organizing The JSON Junk Drawer

Posted on

API storyteller J(a)son Harmon (@jharmn) has a new YouTube channel up called API Workshop. He's going to be publishing regular API design workshop episodes, with the latest one titled REST API Design: Avoid future proofing with the JSON junk drawer. J(a)son provides a nice overview of how you should be structuring the JSON for your API, focusing on the usage of key / value stores. Ironically he uses APIs.json as an example of why you SHOULD NOT use custom key / values within your JSON. What is ironic about this, is that he makes the case for APIs.json properties, giving......read more.



What Exactly Is APIs.json?

Posted on

As I travel around talking to folks about APIs, I spend as much time as I can, educating folks about APIs.json. In the course of my evangelism, I’m constantly reminded how little people, who have even heard, and read about APIs.json, really understand about what it actually is. With this in mind, I will be regularly publishing examples of what APis.json is, to help on-board everyone to Steve (@ngynx), and mine vision for APIs.json. APIs.json is an open format, in partnership between 3Scale and API Evangelist, to help API providers make their APIs more discoverable, assist API brokers in aggregating......read more.



Next Stable Version of APIs.json + APIs.io Is Ready - Are Your APIs Discoverable?

Posted on

Steve (@njyx), Nicolas (@picsoung), and I have been working hard to gather all the feedback from some very smart folks on the API.json format. Now we are stoked to finally announce that we have the 0.14 version ready for prime time. Our goal with the first version of APIs.json, was to just get the idea out there to get feedback from the community, and after four iterations, we feel like the format is now something the community can really build on. First, lets recap, what is APIs.json? APIs.json is a machine readable JSON file that lives in the root of......read more.



Trade.gov Using APIs.json And Added To APIs.io

Posted on

I've been a big proponent of APIs in the federal government, and it makes me really happy to see Developer.Trade.Gov using APIs.json to provide an inventory of APIs available at the federal agency dedicated to strengthening "the competitiveness of U.S. industry, promotes trade and investment, and ensures fair trade through the rigorous enforcement of our trade laws and agreements". If you aren’t familiar with APIs.json, it is the open format that 3Scale and API Evangelist are working on to help make APIs discoverable. You can see APIs.json in action at the open source API search engine APIs.io, where the International......read more.



An APIs.json Collection Of API Resources Across Your Public, Partner Or Internal Resources

Posted on

APIs.json was designed to be a versatile API discovery format, not just a format for public API discovery via search engines like APIs.io. An APIs.json is meant to be a machine readable index of APIs within a single developer hub, providing information on the API endpoints as well as any other supporting resources--there is no reason that all of this can’t also be applied in a private setting. APIs.json can easily be placed within a domain, subdomain, or at any network address, and be used to describe an internal collection of API resources, as well as bring in outside APIs.......read more.



The Power In API Discovery For APIs.json Will Be In The API URL Type

Posted on

An APIs.json file lives in the root of any domain, or subdomain, and provides references to a collection of API resources. The APIs.json is meant to be a lightweight framework, where someone can build a collection of APIs, give it a name, description, some tags, and the APIs collection points you where you need to go, to get more information about those APIs. For each API, you can define a list of URLs, each with a defining “type”, letting you know what to expect when you visit the URL. Right now, most of those URLs are just for humans, pointing to......read more.



Multiple Types of APIs.json For Discovery

Posted on

I’m working through thoughts around a suggestion for future versions of APIs.json API discovery format, and as I do with other things I’m trying to make sense of, I wanted to write a blog post on API Evangelist. If you aren't familiar with the format, APIs.json is meant to be a machine readable JSON file that provides an overview and listing APIs available within a specific domain. Authoritative APIs.json This is an APIs.json that is made available in the root of a domain, that is providing detail on an API that is managed within the same domain. This use case is......read more.



Solving The Problem Of API Discovery

Posted on

API discovery has not changed much since 2005, when John Musser launched ProgrammableWeb, the API directory we've all come to know and love. In 2014 (9 years later), we have Mashape and a handful of other API directory and discovery tools, but we have not made progress on truly being able to discover the best APIs possible, in a distributed, machine-readable way. Steve Willmott of 3Scale, and Kin Lane of API Evangelist, are at it again, looking to provide a possible solution, that we are calling APIs.json—a machine readable listing of your APIs and supporting building blocks that lives in......read more.



Announcing APIs.json At Gluecon 2014

Posted on

One of our favorite events to attend is Gluecon in Broomfield, CO. Eric Norlin and crew has done an amazing job of pulling together the leading technologists, into an intimate venue, where they can discuss the latest technology that acts as the glue of the Internet. Following up on our release of API Commons at Defrag, we will be announcing APIs.json at Gluecon. Eric’s events, both Gluecon and Defrag, provide an excellent forum for not just generating awareness of new technologies, but also stimulating the discussion that is needed to push these technologies forward. If you are at Gluecon, we'd......read more.