{"API Documentation"}

API Documentation Tooling

These are the open source documentation related tooling that I am tracking on as part of my research, and can be used as part of the API documentation process.

agendor-api-docs

Documentation in API Blueprint format for Agendor-API

Aglio

Anu0026nbsp;API Blueprintu0026nbsp;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.u0026nbsp;

api-blueprint-generator-express

Never write documentation anymore! API blueprint generator for node.js.

api-doc-template

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

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.

apitecto-gem

A Ruby library for generating REST Api documentation using API Blueprint

blueprint-converter

Converter from RestDoc to API Blueprint

blueprint-docify

Autogenerate API blueprint documentation with CI for Github pages access

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.

devdocs

API Documentation Browser

dexy

django-rest-swagger

Swagger Documentation Generator for Django REST Framework

dnsimple-developer

The DNSimple API Documentation.

doc-builder

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

docbox

Docbox is an open source version ofu0026nbsp;Mapboxs REST API documentation system.u0026nbsp;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: its Markdown.

docker-aglio

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

dropwizard-swagger

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

Drupal_SwaggerUI

A Drupal 7 custom module that embeds Swagger UI

enki

Renders API Blueprint docs and uploads them to Confluence

express-swagger-doc

Autogenerate express doc from coffeescript in Swagger format

feathers-swagger

Add documentation to your Featherjs services and feed them to Swagger UI.

flair

Express module for generating swagger-format API docs

flask-restplus

Helpers, syntaxic sugar and Swagger documentation for Flask-Restful

grails-swagger

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

grape-swagger-ui

Integrates swagger-ui with rails asset pipeline

hapi-swaggered

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

hapi-swaggered-ui

Easy swagger-ui drop-in plugin for hapi to be used with hapi-swaggered.

hiro

Generate HTML from API Blueprints using Snow Crash and Iglo.

jax-rs-2.0-swagger

Using Swagger for REST API documentation

jekyll-swagger-ui

A Jekyll plugin to integrate Swagger UI into Jekyll site

JerseySwagger

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

puppet-swagger

Puppet module for Swagger UI

RAML API Console

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

RAML to HTML

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

rest-api-docs

QuickBlox REST API Docs (Swagger)

ServiceStack.Api.AngularJS

Generate api documentation in just a few lines of code. (Uses ServiceStack, ServiceStack.Api.Swagger - but not Swagger itself)

slagger

A SlimPHP middleware for generating swagger json documentation for use with Swagger UI

Slate

Slate helps you create beautiful API documentation. Think of it as an intelligent, responsive documentation template for your API. With Slate, the description of your API is on the left side of your documentation, and all the code examples are on the right side. Inspired by Stripes and Paypals API docs. Slate is responsive, so it looks great on tablets, phones, and even print.

slate

Dockerized version of tripit/slate

Swagger UI

Swagger UI is part of Swagger project. The Swagger project allows you to produce, visualize and consume your OWN RESTful services. No proxy or 3rd party services required. Do it your own way. Swagger UI is a dependency-free collection of HTML, Javascript, and CSS assets that dynamically generate beautiful documentation and sandbox from a Swagger-compliant API. Because Swagger UI has no dependencies, you can host it in any server environment, or on your local machine.

swagger-doc

Document your express/restify rest api and expose to swagger ui.

swagger-docs

Generates swagger-ui json files for Rails APIs with a simple DSL.

swagger-js-codegen

A Swagger Codegen for nodejs u0026 angularjs

swagger-maven-plugin

A maven build plugin which helps you generate Swagger JSON and API document during build phase

swagger-rails

Rails app for Swagger API Documentation Template (http://swagger.wordnik.com)

swagger-ui

Swagger UI is a dependency-free collection of HTML, Javascript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.

swagger-ui

Swagger UI is a dependency-free collection of HTML, Javascript, and CSS assets that dynamically gene

swagger-ui_rails

Swagger-ui asset gem

Swagger.Net

Library to document the ASP.NET Web API using the Swagger specification

whiteboard

Simply write beautiful API documentation.

If there is an "open source tool" that should be listed here, submit as a Github Issue, and I will consider adding.