API Evangelist Partners

These are my partners who invest in API Evangelist each month, helping underwrite my research, and making sure I'm able to keep monitoring the API space as I do.

3Scale

3scale makes it easy to open, secure, distribute, control and monetize APIs, that is built with performance, customer control and excellent time-to-value in mind.

Runscope

Runscope is a SaaS-based company that provides solutions for API performance testing, monitoring and debugging.

Tyk

Tyk is an open source API Gateway that is fast, scalable and modern, and offers an API management platform with an API Gateway, API analytics, developer portal and API Management Dashboard.

Restlet

Restlet is providing the fastest and easiest API-First Platform as a Service that developers and non-developers working on API projects can use.

Dreamfactory

DreamFactory Software develops and markets a technology that enables developers to connect modern mobile applications to enterprise back-end infrastructure in the cloud.

API Documentation News

These are the news items I've curated in my monitoring of the API space that have some relevance to the API definition conversation and I wanted to include in my research. I'm using all of these links to better understand how the space is testing their APIs, going beyond just monitoring and understand the details of each request and response.

Title Source Visit
Tweet Thinking about your API documentation Excellent writeup by zachflower on the killer components of API docs httpstcoRMXe79XpAu (2017-05-11) twitter.com
Components of Killer API Docs (2017-05-11) medium.com
The new Box Developer Console is now generally available to all developer accounts (2017-05-03) medium.com
A curated list of free and open sources API documentation tools (2017-05-02) www.linkedin.com
Heres a great hack borrow coding techniques for documentation (2017-04-27) medium.com
Elements of Helpful Code Documentation (2017-04-17) dzone.com
API Docs by Request (2017-04-13) blog.spreedly.com
The End of API Documentation As We Know It (2017-04-12) nordicapis.com
Scribe Labs Google Docs Documentation Tool Released (2017-04-07) blog.scribesoft.com
readmeio Weve got Swagger (2017-03-13) readme.io
Spring Boot RESTful API Documentation With Swagger 2 (2017-03-06) dzone.com
Tweet Convert API documentation into formats such as Swagger API Blueprint and RAML from within Postman Read the blog httpstcoS1KgaO39J4 (2017-02-17) twitter.com
Tweet Docs are up httpstcoCO7p6JsTWy Your API could be covered by spec driven contract tests today no excuses httpstcoC0U9knvkUf (2017-02-15) twitter.com
Leveraging API Documentation for Customer Support (2017-02-08) blog.hitchhq.com
Use Automatic API Documentation Testing To Supercharge API Growth (2017-02-08) nordicapis.com
Box Overhauls its Developer Experience (2017-02-08) www.programmableweb.com
DocumentationDriven API Design (2017-02-07) dzone.com
DocumentationDriven API Design (2017-02-07) dzone.com
Designing Good Static REST API Documentation (2017-02-06) dzone.com
HyperTrack docs have moved from Readmeio to GitBook (2017-02-02) blog.hypertrack.io
Agile documentation for your APIdriven project (2017-02-01) medium.com
Announcing 20 Release of XML Documentation AddOn for Adobe Experience Manager (2017-01-31) blogs.adobe.com
The Ultimate API Documentation Checklist (2017-01-11) blog.readme.io
New Postman Pro Features API Monitoring Documentation Generation and Collaboration Tools (2016-12-14) www.programmableweb.com
API Best Practices Documentation (2016-11-01) medium.com
API Best Practices Documentation (2016-11-01) medium.com
Searching CamelCased parameters in API documentation how we handled it (2016-10-21) blog.algolia.com
Why machine readable documentation is key to your APIs success (2016-10-10) medium.com
An evaluation of autogenerated REST API Documentation UIs (2016-10-07) medium.com
Designing and documenting your API (2016-10-06) medium.com
How to create amazing API documentation (2016-10-05) blog.hitchhq.com
How to create amazing API documentation (2016-10-05) medium.com
New Stoplight Docs a Stoplight API RAML 10 5x Faster API Docs (2016-09-29) blog.stoplight.io
New Life for LoopBack Documentation (2016-09-28) strongloop.com
Announcing the new Docs Repo on GitHub (2016-09-23) blog.docker.com
Box Announces Four New Security and Governance APIs (2016-09-22) www.programmableweb.com
Aglio API Documentation Tool That Has It All JetRuby (2016-09-21) medium.com
Best Practices for Writing API Docs and Keeping Them Up To Date (2016-09-19) blog.readme.io
3 Takeaways From Our First API Meetup (2016-09-16) blog.percolate.com
Implementing Swagger in your API documentation (2016-09-08) idratherbewriting.com
Our Docs Are Now Hosted on GitHub (2016-08-30) blog.parse.com
ASPNET Web API Documentation using Swagger (2016-08-29) www.codeproject.com
A makeover for developer documentation (2016-08-22) developer.intuit.com
Share and document your API with Postman Cloud (2016-08-18) www.theodo.fr
What is the Difference Between API Documentation Specification and Definition (2016-08-16) nordicapis.com
Why You Should Let Robots Help You Write Your API Documentation (2016-08-15) blog.readme.io
Web API documentation can be confusing to read (2016-08-11) www.apiful.io
(2016-08-08) github.com
I hated writing documentation so I founded a company (2016-08-08) blog.readme.io
Tweet CloudFlare039s JSONpowered Documentation Generator httpstcop8Jh2Z0KMH httpstcohnSnOv759z (2016-08-03) twitter.com
API Documentation Almost Done Right (2016-07-22) dzone.com
Stack Overflow Documentation A crowdsourced developer documentation (2016-07-21) stackoverflow.com
Stack Overflow goes beyond QAs and launches crowdsourced documentation (2016-07-21) techcrunch.com
Stack Documentation (2016-07-21) avc.com
StackOverflow Documentation for proprietary web services (2016-07-21) meta.stackoverflow.com
RESTful API Documentation SUCCESS Strategy (2016-07-21) dzone.com
Introducing Stack Overflow Documentation Beta (2016-07-20) blog.stackoverflow.com
Why Developers Write Horrible Documentation and How to Solve It (2016-07-13) dzone.com
Presentation We Need to Talk About Docs (2016-07-12) www.infoq.com
How the Right Technical Writer Can Take API Docs from Good to Great (2016-06-21) www.programmableweb.com
OpenGLAM Documentation updated (2016-05-12) openglam.org
API Documentation Matters More than Performance and Functionality (2016-05-06) blog.smartbear.com
API Views With OpenAPI Spec And Liquid (2016-05-04) dzone.com
MSDNTechNet Being Open Sourced as docsmicrosoftcom (2016-05-03) www.infoq.com
Introducing the Postmark API Explorer (2016-04-28) postmarkapp.com
Simplifying API documentation for a great first user experience (2016-04-25) blog.getpostman.com
Get Around Dev Docs Faster (2016-04-15) developer.salesforce.com
Jennifer Rondeau on the mix of grammar and tech in API documentation (2016-04-13) apieconomist.com
Providing Specialized Views Of An API Surface Area Dynamically With OpenAPI Spec And Liquid (2016-04-09) apievangelist.com
Further Simplifying My API Docs and Providing API Samples (2016-03-29) dzone.com
Introducing the Google API Console (2016-03-24) developers.googleblog.com
Tutorials from Twilio The new documentation experience from Twilio (2016-03-21) www.twilio.com
Further Simplifying My API Docs And Providing API Samples (2016-03-17) apievangelist.com
API Documentation Needs to be Simpler (2016-03-13) dzone.com
It Would Be Nice To Have Some Simpler Interactive API Documentation In Addition To What We Have Now (2016-03-07) apievangelist.com
Docbox an open source API documentation system (2016-03-07) www.mapbox.com
Best Practices in Action The Best Buy API Query Builder (2016-03-04) www.wipfactory.com
Meet the new Mapbox API documentation (2016-03-04) www.mapbox.com
Documentation First A Recipe for API Success (2016-02-27) dzone.com
Writing for Software Engineers On Not Treating People as Code (2016-02-25) dzone.com
REST API Documentation Using JAXRSANALYZER (2016-02-20) dzone.com
Do You Publish API Docs Online for Availability to Third Party Developers (2016-02-18) www.programmableweb.com
I Am Liking The Modular Services That Are Delivering In Specific Areas Of API Life Cycle Like APIDocsio (2016-02-17) apievangelist.com
Spring REST Docs 110M1 (2016-02-16) dzone.com
RESTful Web API Help Documentation using Swagger UI and Swashbuckle (2016-02-15) www.codeproject.com
REST API Documentation Part 2 Swagger RAML and Open API (2016-02-02) dzone.com
A New Open Source Interactive API Documentation From Folks Over At Lucybot (2016-01-25) apievangelist.com
Building Your API Documentation Strategy For SUCCESS (2016-01-22) launchany.com
SpringOne2GX 2015 Replay Documenting RESTful APIs (2016-01-21) dzone.com
Documenting RESTful APIs (2016-01-19) dzone.com
10 Questions Your API Documentation Must Answer (2016-01-12) launchany.com
Just The Best Parts Of The API Documentation Please (2016-01-12) apievangelist.com
Bad API documentation Why and what you can do about it (2016-01-08) cloudrail.com
Indix Product API Documentation Enhancements (2016-01-07) www.indix.com
DocumentAPItopia API Days Paris 2015 (2015-12-16) apihandyman.io
Moving Beyond API Reference Documentation (2015-12-10) launchany.com
The Utopia of API Documentation (2015-12-07) blog.smartbear.com
HTML documentation for your API (2015-10-21) restlet.com
Why API Providers Must Offer Solid API Documentation (2015-09-13) www.programmableweb.com
Our Brand New Docs (2015-08-11) www.pushwoosh.com
The Responsive Swagger Driven Version of Slate API Documentation I Was Looking For (2015-06-26) apievangelist.com
We Should Be Generating Slate From Swagger So We Maintain A Machine Readable Core (2015-06-25) apievangelist.com
Announcing New Docs for Keen IO (2015-06-24) keenio.tumblr.com
Better Living Through Documentation (2015-05-27) datamade.us
Using Templates for Documentation Driven API Design (2015-02-19) nordicapis.com
Why You Should Use Markdown for Your API Documentation (2015-02-19) www.programmableweb.com
Dash Simplifies API Documentation for Mac iOS Developers (2015-02-18) www.programmableweb.com
Why We Open Sourced Our Docs and How We Did It (2015-02-18) blog.respoke.io

If you think there is a link I should have listed here feel free to tweet it at me, or submit as a Github issue. Even though I do this full time, I'm still a one person show, and I miss quite a bit, and depend on my network to help me know what is going on.

API Documentation Organizations

These are the organizations I come across in my research who are doing interesting things in the API space. They could be companies, institutions, government agencies, or any other type of organizational entity. My goal is to aggregate so I can stay in tune with what they are up to and how it impacts the API space.

SDK Bridge

SDK Bridge is a company that specializes in explaining technology through documentation and software development kits. It provides a variety of API-related services including: API Documentation Sample code and tutorials Highly technical copywriting Training sessions on how to use software platforms Technology classes for youth These services can be a critical piece of delivering your API. SDK Bridge says that it is a bridge between people and technology. So very true. SDK Bridge provides a set of services that any business looking to deliver an API should evaluate. Even though you many be able to generate your own marketing materials, SDK and other supporting API documents, you may find more value bring in an outside perspective to make sure you explain how your API solves problems, adds value, and can be successfully integrated to customers systems.

ReadMe.io

ReadMe is a developer hub for your startup or code. It's a completely customizable and collaborative place for documentation, support, key generation and more. Don't waste your precious time reimplementing a dev.yourstartup.com. If you have an API, code library, or affiliate program, documentation is hard. Users can't use your product without understanding it, and most documentation on the Internet is lacking. The goal of ReadMe is to make consuming APIs completely painless.

APIEmbed

Auto-generated code snippets in many programming languages for your website, blog or API documentation.

Atlassian Confluence

Confluence is a wiki used by more than half of Fortune 100 companies to connect people with the content and co-workers they need to get their jobs done, faster. Connect your entire business in one place online to collaborate and capture knowledge – create, share, and discuss your documents, ideas, minutes, and projects.

REST United

Our mission is to help REST API providers easily create SDKs in different programming languages with easy-to-follow documentation and code samples while software developers can effortlessly consume the REST API by following the SDK installation instruction and using the code samples within minutes.

Dexy

Dexy helps your code to speak for itself. Show off your code with beautiful syntax highlighting. Write examples and Dexy will run them, inserting the output into any document you wish. Everything is based on live code, so updating is easy, syntax errors blow up on you, not your users, and typos are a thing of the past. With Dexy's smart caching, your code is only executed when it needs updating, saving you time while keeping your documents robust.

API Docs

Hosted public API documentation for every OAS (Swagger) and RAML spec out there.

Apidox

Apidox is a free to use, open source application. Code released under the MIT license. Contact, support and error reporting on GitHub.

Read the Docs

Read the Docs hosts documentation, making it fully searchable and easy to find. You can import your docs using any major version control system, including Mercurial, Git, Subversion, and Bazaar. We support webhooks so your docs get built when you commit code. There's also support for versioning so you can build docs from tags and branches of your code in your repository.

Apiary

Apiary.io is a hosted suite of tools that help companies build web APIs quickly, test and monitor them easily and document them effortlessly. It provides API owners with necessary infrastructure and helps them build relationship with their users. Core of the self-service solution is API Blueprint, an efficient format for describing an API, aspiring to define new gold standard for REST API development. The product uses this Blueprint to streamline adoption of new services and simplify integration to other systems.

Gelato.io

Gelato.io is a tool for creating really great API Documentation and Developer Portals. You can describe your API, import and sync with Swagger or API Blueprint, write awesome guides (or get them written for you), have your developers register and get updates when things change, get an automatic API Explorer - everything a good Documentation Site needs and more!

If you think there is an organization I should have listed here feel free to tweet it at me, or submit as a Github issue. Even though I do this full time, I'm still a one person show, and I miss quite a bit, and depend on my network to help me know what is going on.

API Documentation Tooling

As I study each API, and API related service, I'm always looking for open source tooling that has been developed around each area of the API life cycle. This is an aggregate of tooling I've come across and aggregated as part of my API testing research.

Documentation

docker-aglio

(API Blueprint) Dockerfile for running Aglio - https://github.com/danielgtaylor/aglio

doca

A CLI tool that scaffolds API documentation based on JSON HyperSchemas.

dropwizard-swagger

a Dropwizard bundle that serves Swagger UI static content and loads Swagger endpoints.

grails-swagger

A Grails 2.3+ plugin to generate REST API documentation for your endpoints

apitecto-gem

A Ruby library for generating REST Api documentation using API Blueprint

RAML to HTML

A simple RAML to HTML documentation generator written for Node.js. RAML to HTML gets a RAML file and outputs the API documentation on a single HTML page.

Aglio

An API Blueprint renderer that supports multiple themes and outputs static HTML that can be served by any web host. API Blueprint is a Markdown-based document format that lets you write API descriptions and documentation in a simple and straightforward way.

API Changelog

API Changelog monitors the docs of APIs you depend on and sends you notifications when they change. API Changelog is brought to you by Runscope. Solve API errors fast. Debug, test and share your API calls. 

RAML API Console

API Console is a graphical user interface for a RAML-defined API that visually exposes the API’s structure and important patterns and serves as interactive API documentation. It is provided under the open-source CPAL license.

apidoc-swagger

apidoc and swagger are two nice projects which are focusing on documentation of APIs. This project is a middle tier which tries to bring them together in a sense that it uses apidoc to convert inline documentation to json schema and later convert it to swagger json schmea.

Carte

Carte is a simple Jekyll based documentation website for APIs. It is designed as a boilerplate to build your own documentation and is heavily inspired from Swagger and I/O docs. Fork it, add specifications for your APIs calls and customize the theme. Go ahead, see if we care.

docbox

Docbox is an open source version of Mapbox's REST API documentation system. It takes structured Markdown files and generates a friendly two-column layout with navigation, permalinks, and examples. The documentation source files that Docbox uses are friendly for documentation authors and free of presentational code: it's Markdown.

flair

Express module for generating swagger-format API docs

hiro

Generate HTML from API Blueprints using Snow Crash and Iglo.

doc-builder

Generates Swagger documentation for a RESTful service by analyzing the HTTP request and response

api-doc-template

mustache templates, used to generate RESTful API Document with the help of Swagger

enki

Renders API Blueprint docs and uploads them to Confluence

JerseySwagger

Test using Jersey for REST api + documentation of the API using swagger-ui

ReDoc

OpenAPI/Swagger-generated API Reference Documentation

hapi-swaggered

Yet another hapi plugin providing swagger compliant API specifications based on routes and joi schemas to be used with swagger-ui.

If there is a tool that you think should be listed here, let me know by submitting a Github issue or Tweeting a link at me. I'm always looking for new types of tools, and get better at organizing them here and making sense.