Day: April 3, 2018

I have been editing my OpenAPI definitions manually for some time now, as I just haven’t found a GUI editor that works well with my workflow. Swagger editor really isn’t a GUI solution, and while I enjoy services like Stoplight.io, APIMATIC, and others, I’m very picky about what I adopt within my world. One aspect of this is that I’ve been holding out for a solution that I can run 100% on GitHub using GiHhub Pages. I’ve delusionally thought that someday I would craft a slick JavaScript solution that I could run using only GitHub Pages, but, in reality, I’ve never had the time to pull it together. So, I just kept manually editing my OpenAPI definitions on the desktop using Atom, and publish to GitHub as needed.

Well, now I can stop being so dumb because my friend Mike Ralphson (@permittedsoc) has created my new favorite OpenAPI GUI, that is OpenAPI 3.0 compliant by default. As Mike defines it, “OpenAPI-GUI is a GUI for creating and editing OpenAPI version 3.0.x JSON/YAML definitions. In its current form, it is most useful as a tool for starting off and editing simple OpenAPI definitions. Imported OpenAPI 2.0 definitions are automatically converted to v3.0.” https://goo.gl/9sFgKK #DataIntegration #ML

ICYMI: I’m big on supporting API providers that publish their OpenAPI definitions to GitHub. It is important for the wider API community that ALL API definitions are machine-readable and available in a way that can be forked and integrated into continuous integration pipelines. I’m not even talking about the benefits to the API providers when it comes to managing their own API lifecycle. I’m just focusing on the benefits to API consumers, and helping to make onboarding, integration, and keeping in sync with the roadmap as frictionless as possible.

To help incentivize API providers doing this, I’m committed to writing up stories for each API provider that publishes their OpenAPI, APIs.json, or Postman Collections to GitHub. Bonus points if you are doing it in an interesting way that further benefits your operations, as well as your community. Today’s API provider to showcase is the SMS, voice and phone verifications API provider Nexmo, who tweeted the GitHub repository at me, which contains their OpenAPI definition for their APIs. As they say, it is a work in progress, but it provides a damn good start for a machine-readable definition for their API(s), and I mean c’mon, aren’t all of our APIs a work in progress? https://goo.gl/jn9V8H #DataIntegration #ML