An open API service indexing awesome lists of open source software.

awesome-api-documentation-tools

A Collection of Awesome API Documentation Tools
https://github.com/furudo-erika/awesome-api-documentation-tools

Last synced: 19 days ago
JSON representation

AI-Powered Documentation Tools

  • DeepDocs - AI documentation generator for APIs.
  • QuickType - AI-powered JSON schema generation and documentation.
  • Docstring AI - AI-assisted documentation generator for code.
  • CodeDoc AI - AI-powered documentation generator for programming languages.
  • DeepDocs - AI documentation generator for APIs.

API Design Tools

  • Apicurio Studio - Open-source API design studio with documentation features.
  • API Sprout - Lightweight, embeddable API mock server for prototyping documentation.
  • Prism - Open-source HTTP mock server with API documentation features.

API Gateways with Doc Features

  • Kong - API gateway with documentation portal features.
  • Tyk - API gateway with documentation capabilities.
  • APIGateway - Amazon's API gateway with documentation features.
  • Apigee - Google Cloud's API management platform with documentation.
  • WSO2 API Manager - Open source API management platform with documentation portal.

API Monitoring Tools

  • API Metrics - API analytics platform with documentation usage tracking.
  • Moesif - API analytics and monitoring service with documentation engagement tracking.
  • RapidAPI Analytics - Analytics platform for API usage with documentation tracking.
  • DocOps - Documentation analytics and optimization platform.
  • APImetrics - API performance monitoring with documentation usage analytics.

API Testing with Doc Features

  • SoapUI - API testing tool with documentation features for REST and SOAP APIs.
  • Pact - Contract testing tool with documentation for microservices.
  • Dredd - API testing tool that validates API descriptions against implementation.
  • HTTPie - Command-line HTTP client with documentation generation capabilities.
  • REST-Assured - Java testing library with documentation features for REST APIs.
  • Karate - API test automation with documentation capabilities.
  • Chakram - API testing framework with documentation features.

Complete Platforms

  • Apidog - An integrated platform for API design, debugging, testing, documentation, and mocking. Offers collaborative features specifically tailored for API development teams.
  • ![
  • Postman - API platform for building and using APIs with features for request building, automated testing, and documentation generation.
  • SwaggerHub - Collaborative platform for API design and documentation built around the OpenAPI Specification.
  • Stoplight - A design-first API platform with visual modeling, documentation, and testing tools.
  • Insomnia - Open-source API client with design, testing, and documentation capabilities.
  • ReadMe - Personalized and interactive API documentation platform with analytics.
  • Apiary - API design and documentation platform with mock server capabilities.
  • RapidAPI - API marketplace with documentation features for API providers.
  • Hoppscotch - Open source API development ecosystem with documentation features.
  • SwaggerHub - Collaborative platform for API design and documentation built around the OpenAPI Specification.

Documentation Generators

  • Redocly - Tools for creating, managing, and publishing API documentation built on OpenAPI.
  • OpenAPI Generator - Generate documentation and client libraries from OpenAPI specifications.
  • ApiDoc - Documentation generator from API annotations in source code.
  • JSDoc - API documentation generator for JavaScript.
  • Swagger Codegen - Generate documentation and client libraries from Swagger definitions.
  • Docusaurus - React-based static site generator optimized for documentation websites.
  • Javadoc - Documentation generator for Java APIs.
  • TypeDoc - Documentation generator for TypeScript projects.
  • NSwag - Swagger/OpenAPI toolchain for .NET with documentation generation capabilities.
  • drf-yasg - Automated generation of Swagger/OpenAPI documentation for Django REST Framework APIs.
  • GraphDoc - Static page generator for GraphQL schema documentation.
  • Doctave - Documentation site generator with a focus on API documentation.
  • Raml2Html - RAML to HTML documentation generator.
  • Doxygen - Documentation generator for multiple programming languages.

Documentation Hosting

  • GitHub Pages - Free hosting for project documentation directly from a GitHub repository.
  • GitBook - Modern documentation platform for teams.
  • ReadTheDocs - Documentation hosting platform with full-text search.
  • Netlify - Platform for hosting static documentation sites.
  • Surge - Static web publishing for documentation sites.
  • Vercel - Platform for hosting documentation with seamless Git integration.
  • Heroku - Cloud platform that can be used to host documentation apps.
  • Cloudflare Pages - JAMstack platform for hosting documentation sites.

Documentation Templates

IDE Extensions & Plugins

Language-Specific Tools

  • Godoc - Documentation generator for Go projects.
  • pydoc - Documentation generator for Python.
  • Yard - Documentation generator for Ruby.
  • Sandcastle - Documentation compiler for .NET projects.
  • ESDoc - API documentation generator for JavaScript.
  • Swiftdoc - Documentation generator for Swift.
  • Jazzy - Documentation generator for Swift and Objective-C.
  • PHPDoc - Documentation generator for PHP projects.
  • PHPDoc - Documentation generator for PHP projects.
  • Sphinx - Python documentation generator with API doc support.

Markdown Tools

  • MkDocs - Static site generator for documentation using Markdown.
  • Docsify - Documentation site generator without static HTML files.
  • Markdown-it - Markdown parser with plugins for documentation features.
  • Remarkable - Markdown parser with extension support for documentation.
  • Docz - Documentation generator using Markdown and JSX.

Mock Servers

  • Mockoon - Mock API server with documentation features.
  • Prism - HTTP mock server for OpenAPI specs.
  • JSON Server - Fake REST API server with documentation features.
  • WireMock - Flexible API mocking with documentation capabilities.
  • MockServer - Easy mocking of REST and SOAP services for documentation.

Open Source Tools

  • Swagger UI - Interactive API documentation generator that visualizes OpenAPI specifications.
  • ReDoc - OpenAPI/Swagger documentation generator creating responsive, three-panel documentation.
  • Slate - Beautiful static API documentation based on Markdown.
  • DapperDox - Documentation generator for OpenAPI specifications.
  • Docbox - REST API documentation system built with React.
  • LucyBot - Generate API documentation websites from OpenAPI specifications.
  • widdershins - OpenAPI/Swagger/AsyncAPI definition to Markdown/Slate/HTML documentation.
  • Spectaql - Documentation generator for GraphQL APIs.
  • DevDocs - Open-source API documentation browser.
  • APITree - An open-source tool for visualizing and documenting APIs.

Resources

Specification Tools

  • OpenAPI (Swagger) Specification - The standard for describing RESTful APIs.
  • API Blueprint - A documentation-oriented API description language.
  • RAML - RESTful API Modeling Language for designing RESTful APIs.
  • JSON Schema - Vocabulary that allows validation of JSON documents.
  • GraphQL - Query language and runtime for APIs that provides a complete description of the data available.
  • WSDL - XML-based interface description language for SOAP services.
  • gRPC - High-performance RPC framework with built-in documentation via Protocol Buffers.
  • AsyncAPI - Specification for event-driven APIs.
  • HAL - Hypermedia Application Language for building hypermedia-driven APIs.
  • OpenRPC - Specification for JSON-RPC 2.0 APIs.

Static Site Generators for Docs

  • VuePress - Vue-powered static site generator with API documentation features.
  • Jekyll - Static site generator often used for API documentation.
  • Hexo - Fast and simple static site generator with documentation themes.
  • Hugo - Fast static site generator with documentation themes and features.
  • Gatsby - React-based static site generator for documentation sites.

Visual Documentation Tools