swagger2markup - A Swagger to AsciiDoc or Markdown converter to simplify the generation of an up-to-date RESTful API documentation by combining documentation that’s been hand-written with auto-generated API documentation

•    Java

---

The primary goal of this project is to simplify the generation of an up-to-date RESTful API documentation by combining documentation that’s been hand-written with auto-generated API documentation produced by Swagger. The result is intended to be an up-to-date, easy-to-read, on- and offline user guide, comparable to GitHub’s API documentation. The output of Swagger2Markup can be used as an alternative to swagger-ui and can be served as static content. NOTE: The Swagger Specification has been donated to to the Open API Initiative (OAI) and has been renamed to the OpenAPI Specification. Swagger2Markup converts a Swagger JSON or YAML file into several AsciiDoc or GitHub Flavored Markdown documents which can be combined with hand-written documentation. The Swagger source file can be located locally or remotely via HTTP. Swagger2Markup supports the Swagger 1.2 and 2.0 specification. Internally it uses the official swagger-parser and my markup-document-builder.

api documentation swagger asciidoc markdown

apidoc - RESTful web API Documentation Generator.

•    Javascript

---

Generates a RESTful web API Documentation.apiDoc creates a documentation from API descriptions in your source code. It has support of API history, with that various API version levels can be compared.So it can be retraced what changed in the API since the last version.

api apidoc doc documentation rest restful api-documentation

JSDoc - An API documentation generator for JavaScript

•    Javascript

---

JSDoc 3 is an API documentation generator for JavaScript, similar to Javadoc or phpDocumentor. You add documentation comments directly to your source code, right alongside the code itself. The JSDoc tool will scan your source code and generate an HTML documentation website for you.

api docs documentation help api-docs api-documentation

abao - REST API automated testing tool based on RAML

•    CoffeeScript

---

Abao is a command-line tool for testing API documentation written in RAML format against its back-end implementation. With Abao, you can easily plug your API documentation into a Continuous Integration (CI) system (e.g., Travis, Jenkins) and have API documentation up-to-date, all the time. Abao uses Mocha for judging if a particular API response is valid or not. This version of the software only supports the RAML-0.8 specification.

api test testing documentation integration acceptance raml automated

SLATE - Beautiful static documentation for your API

•    Javascript

---

Slate helps you create beautiful, intelligent, responsive API documentation. Slate is responsive, so it looks great on tablets, phones, and even in print. The description of your API is on the left side of your documentation, and all the code examples are on the right side. It supports Syntax highlighting, Markdown, RTL support and lot more.

slate api-documentation api static-site-generator

eoLinker-AMS-Lite-For-PHP - 中国最大的API接口管理平台，3.x开源发行版，支持多国语言[英语、简体中文、繁体中文]

•    PHP

---

中国最大的API接口管理平台，3.x开源发行版，支持多国语言[英语、简体中文、繁体中文]

eolinker-ams apimanager api-management api api-documentation api-service mysql angular angularjs mock-data mockjs testing-tools apitest api-testing api-test-platform api-documentation-tool ci ci-cd

office-js-docs - Microsoft Office Add-ins API Reference Documentation

•    Batchfile

---

Welcome to the Office JavaScript API Reference documentation. In this repository, you can find the documentation source files for Office JavaScript API Reference. For the best experience, we recommend you view this content on Office Developer Center.Additionally, the branches within this repository contain Open Specifications for host-specific JavaScript APIs such as the Excel JavaScript API and Word JavaScript API.

api-console - A Web Component for an interactive REST console based on RAML files

•    HTML

---

See live example of the API console in our demo application. MuleSoft's API Console is a full-fledged API documentation tool that generates mobile-friendly web documentation based on RAML (Restful API Modeling Language) documents. In addition to providing documentation, the tool provides the capability for users to try out requests on the fly.

raml raml-tooling raml-document

grape-swagger - Add OAPI/swagger v2.0 compliant documentation to your grape API

•    Ruby

---

The grape-swagger gem provides an autogenerated documentation for your Grape API. The generated documentation is Swagger-compliant, meaning it can easily be discovered in Swagger UI. You should be able to point the petstore demo to your API. This screenshot is based on the Hussars sample app.

api grape documentation oapi swagger

openapi-generator - OpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an OpenAPI Spec (v2, v3)

•    HTML

---

OpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an OpenAPI Spec (v2, v3)

rest-api rest-client sdk generator restful-api api api-client api-server openapi3 openapi rest

DevDocs - API Documentation Browser

•    Ruby

---

DevDocs combines multiple API documentations in a fast, organized, and searchable interface.Unless you wish to contribute to the project, I recommend using the hosted version at devdocs.io. It's up-to-date and works offline out-of-the-box.

devdocs documentation documentation-tool developer-tools docs offline app api-documentation pwa offline-documentation

docbox - REST API documentation generator

•    CSS

---

Docbox is an open source 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. Docbox is a JavaScript application written with React. The core magic is thanks to the remark Markdown parser, which enables the layout: after parsing a file into an Abstract Syntax Tree, we can move examples to the right, prose to the left, and build the navigation system.

api documentation

yuidoc - YUI Javascript Documentation Tool

•    HTML

---

YUI's JavaScript Documentation engine. YUIDoc is a Node.js application used at build time to generate API documentation for JavaScript code. YUIDoc is comment-driven and supports a wide range of JavaScript coding styles. The output of YUIDoc is API documentation formatted as a set of HTML pages including information about methods, properties, custom events and inheritance for JavaScript objects.

yui jsdoc coffeescript api documentation javadoc docs apidocs

ReDoc - 📘 OpenAPI/Swagger-generated API Reference Documentation

•    TypeScript

---

IMPORTANT NOTE: if you work with untrusted user spec, use untrusted-spec option to prevent XSS security risks.

openapi swagger api-documentation documentation-tool documentation-generator redoc reactjs openapi-specification json-schema api rest documentation react.js

aws-apigateway-importer - Tools to work with Amazon API Gateway, Swagger, and RAML

•    Java

---

The Amazon API Gateway Importer lets you create or update Amazon API Gateway APIs from a Swagger or RAML API representation.To learn more about API Gateway, please see the service documentation or the API documentation.

protagonist - Protagonist is Node.js wrapper for the API Blueprint parser

•    C++

---

Protagonist is a Node.js wrapper for the Drafter library. API Blueprint is Web API documentation language. You can find API Blueprint documentation on the API Blueprint site.

api-blueprint nodejs-modules nodejs-library

snowcrash - API Blueprint Parser

•    C++

---

Snow Crash is the reference API Blueprint parser built on top of the Sundown Markdown parser. API Blueprint is Web API documentation language. You can find API Blueprint documentation on the API Blueprint site.

vimeo - A full featured Ruby implementation of the Vimeo API

•    Ruby

---

This gem implements a full-featured Ruby interface for the Vimeo API v2. For a more in depth look at the API check out Vimeo's Simple API Documentation or Vimeo's Advanced API Documentation. I would also recommend checking out the API Forums if things aren't working as they should.

Swagger - The World's Most Popular API Framework

•    Java

---

Swagger is a powerful open source framework backed by a large ecosystem of tools that helps you design, build, document, and consume your RESTful APIs. The goal of Swagger is to define a standard, language-agnostic interface to REST APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection.

rest-api api-framework api-specification api-testing rest-framework api-documentation apidoc

discord-api-docs - Official Discord API Documentation

•    Javascript

---

This repo contains the official Discord API documentation, which can be viewed online HERE. Before submitting pull-requests, please remember to fully read the Contributing guidelines. This repository uses special markdown syntax that helps style the resulting web version of the documentation.

discord-api discord discordapp memes