Awesome GitHub RepositoriesAPI Documentation

Slate is a static API documentation generator and developer documentation framework. It transforms API specifications and text files into a formatted static website designed for hosting API references and guides. The system functions as a static site generator that builds a developer portal without the need for a backend database. It manages API reference details by organizing technical endpoints into a readable format and providing a structured layout for developer consumption. The framework covers content generation and site architecture, including the compilation of markdown guides and th

Slate is a static API documentation generator and reference website builder. It transforms API specifications and Markdown files into a professional, hosted static site used for developer portals and REST API referencing. The tool creates a single-page API reference guide that integrates code samples and request-response examples. It utilizes a two-pane layout architecture to separate navigation from detailed endpoint descriptions. The system includes a Markdown-based content pipeline and static site generation to produce flat HTML files. It provides client-side search indexing and a respons

Swagger UI is an OpenAPI specification renderer and documentation interface that transforms JSON or YAML API definitions into a navigable, searchable website. It functions as an OpenAPI documentation UI and request client, providing a visual catalog for exploring endpoints and sending live HTTP requests to a server using a schema-defined interface. The project distinguishes itself through a plugin-based extension system and a schema-driven UI generation model. This architecture allows for the injection of custom components, state selectors, and helper functions to modify core behavior and lay

ReDoc is an OpenAPI documentation generator that transforms OpenAPI and Swagger specifications into interactive, three-panel API reference websites. It provides a system for generating these references as standalone static HTML files or as embedded UI components for integration into existing websites and developer portals. The tool organizes API specifications into a responsive layout featuring a navigation sidebar, detailed endpoint descriptions, and language-specific code samples. It supports the visualization of complex data models by mapping schema definitions to human-readable tables and

Redoc is an API documentation generator that transforms standard API specification files into interactive, responsive, and highly customizable web-based documentation interfaces. It provides a three-panel layout that includes synchronized navigation, code samples, and search functionality, allowing developers to explore endpoints and schemas directly within a browser-based environment. Beyond rendering, the project functions as an API governance toolkit that enforces structural standards and quality rules across API definitions. It includes a suite of processing utilities for bundling, splitt

Scalar is a platform for building and managing API specifications, focusing on OpenAPI and AsyncAPI standards. It provides tools to generate interactive API references with embedded testing interfaces, create mock servers for pre-implementation testing, and build offline-first API clients that sync with backend frameworks. The platform also supports version upgrades of specifications to maintain compatibility and includes command-line utilities for local development and document management. The project distinguishes itself through automated release workflows that generate changelogs and publi

AsyncAPI es un estándar de especificación legible por máquina para definir y documentar interfaces orientadas a eventos y arquitecturas basadas en mensajes asíncronos. Proporciona un framework unificado para modelar la estructura de sistemas distribuidos, incluyendo la definición de servidores, canales, mensajes y operaciones. La especificación se distingue por utilizar una capa de diseño agnóstica al protocolo, que separa las definiciones de interfaz principales de las configuraciones específicas de transporte. Esto permite a los desarrolladores mantener una única fuente de verdad mientras se adaptan a los requisitos únicos de diversas tecnologías de mensajería como Kafka, MQTT o WebSockets. Además, soporta entornos distribuidos complejos al permitir la correlación de mensajes en tiempo de diseño y el seguimiento de expresiones en tiempo de ejecución para mejorar la observabilidad. El proyecto cubre una amplia superficie de capacidades, incluyendo esquemas de seguridad declarativos para autenticación y autorización, y modelado de datos estandarizado mediante formatos como JSON Schema o Avro. También proporciona mecanismos para modularizar definiciones de API grandes a través de componentes reutilizables y registros, lo que facilita la gobernanza y la consistencia organizacional. La especificación se mantiene como un conjunto de archivos de documentación estandarizados, proporcionando una base para el aprovisionamiento automatizado de infraestructura y la gestión de topologías de red orientadas a eventos.

Aglio es una herramienta de interfaz de línea de comandos y renderizador de HTML estático diseñado para convertir archivos de especificación API Blueprint en documentación legible basada en web. Transforma especificaciones de API estructuradas en páginas HTML independientes que pueden alojarse y distribuirse sin necesidad de un servidor backend. El proyecto incluye un motor de temas que permite la personalización de estilos visuales mediante variables CSS y sobrescritura de plantillas de diseño. Los usuarios pueden aplicar temas integrados o integrar módulos externos para cambiar cómo se renderiza la documentación. La herramienta admite la composición modular de documentos, permitiendo la fusión de múltiples archivos de especificación y markdown en un solo documento mediante inclusiones de rutas relativas. También proporciona un servidor de desarrollo local con vista previa de recarga en vivo para ver los cambios renderizados en tiempo real.

Fern is a toolset for managing API specifications, generating type-safe client libraries, and producing hosted developer documentation. It provides a utility for validating, transforming, and exporting API definitions into standardized OpenAPI formats, serving as a system to maintain a consistent source of truth for API designs. The project differentiates itself through an automated SDK distribution pipeline that publishes generated libraries to package managers such as npm, PyPI, Maven, and NuGet. It also includes an AI-powered search assistant trained on API and SDK specifications to answer

Build beautiful, interactive API Docs with embeddable React or Web Components, powered by OpenAPI and Markdown.

JSON Schema tools and doc generation for HTTP APIs

RapiDoc -WebComponent for OpenAPI Spec

OpenAPI / Swagger, AsyncAPI & Semoasa definitions to (re)Slate compatible markdown

Autogenerate static GraphQL API documentation

REST API documentation generator

Framework for building high quality, interactive API documentation.

Author full documentation in GitHub Flavoured Markdown. Document multiple API specifications as a suite of cross-referenced products. Seamlessly overlay content onto the automatically generated reference documentation. Integrate the built-in API explorer with your APIs and authentication model.…

Web Component Custom Element for Open-API spec viewing, with automatic integration for React and Vue.