Skip to content

Instantly share code, notes, and snippets.

@yrashk
Last active October 1, 2015 05:46
Show Gist options
  • Star 2 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save yrashk/2a0af6c5a46546e5a6cb to your computer and use it in GitHub Desktop.
Save yrashk/2a0af6c5a46546e5a6cb to your computer and use it in GitHub Desktop.
We will document, design and produce API bindings for all popular languages

Implementable

API Accessibility Program

TL;DR: We will document, design and produce API bindings for all popular languages.


Somebody once said, "good APIs are like good jokes — you don't need to explain them."

We're building a microservices marketplace platform, and we want to offer a strategic service to fellow engineering teams.

We will properly document your existing APIs, design and produce up-to-date bindings for them.

We've designed this offering to be as low-touch as possible. We work alongside with your team to keep the API documentation & bindings up-to-date requiring as little time from the team as possible.

What do I get?

You will get a modeled API as an IDL file (viewable in our app) and a generated source code for all programming languages supported in your plan, pushed out to repositories designated by you.

The bindings will be regularly updated according to your changes so that your team and your customers can always have an up-to-date library for a language of their choice.

What do we do differently?

We put people in front of this task. There is a number of open source projects and companies that are working on automating the process end-to-end, but the results are rather mixed due to missing/misunderstood models and schemas. We've decided to offer a full service augmented by human intelligence.

In a departure from commonly used approaches, we don't start with documenting endpoints (HTTP REST, JSON, XML). Instead, we start with your domain model and the expected interactions with the API. Once that's properly captured, we map the model to actual endpoints and produce the binding libraries.

As a result, both your engineering team and your customers (if your API is public) will get meaningful domain-driven libraries, not a mere mapping of HTTP calls.

What languages do you support?

We're starting with JavaScript, Ruby, Java and Go. We'll be adding more languages based on public and private feedback.

How does it work?

Once you've signed up, we'll be in touch with you shortly to gather as much information about your API.

After that, depending on the size of the API, you will receive a notification from us within a few days to a week to confirm the first draft and collaborate with us to bring it to perfection. We are using our own IDL format that allows us to capture all the domain modeling and mapping aspects and generate different kind of machine-readable and visual outputs.

Once everybody's happy, we'll generate your API bindings within a few days (we're working on cutting that time down!) and push it to your Git repository.

After we've published the bindings, we'll be sending you an automated reminder every month to see if anything has changed in your API worth addressing (you can also proactively notify us if you're in a rush!). We'll be also releasing a self-service application for API maintenance.

Pricing

The below pricing is per complete business logic domain. If you're

Public API Private API
All supported programming languages Up to 3 programming languages
Code pushed to public repositories Code pushed to private repositories
1 API update per month 2 API updates per month
 
$995 one-time, $99/mo maintenance $695 one-time, $69/mo maintenance
$695 one-time, $69/mo maintenance $495 one-time, $49/mo maintenance
(LIMITED TIME OFFER) (LIMITED TIME OFFER)

We strive to keep the pricing for this offer simple. The above figures are for an average size API, if your API includes a significant number of domain models and/or endpoints, we'll give you a custom Enterprise plan quote.

And finally, our 90 days money-back guarantee: if you are not happy with the results (for whatever reason), we'll make it right or issue a refund.

-- @yrashk


If you have any questions, e-mail us at hi@implementable.io or leave a comment below.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment