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 este un standard de specificație lizibil de către mașină pentru definirea și documentarea interfețelor bazate pe evenimente și a arhitecturilor asincrone bazate pe mesaje. Acesta oferă un framework unificat pentru modelarea structurii sistemelor distribuite, incluzând definirea serverelor, canalelor, mesajelor și operațiunilor. Specificația se distinge prin utilizarea unui strat de design agnosticism față de protocol, care separă definițiile de bază ale interfeței de configurațiile specifice transportului. Acest lucru permite dezvoltatorilor să mențină o singură sursă de adevăr, adaptându-se în același timp cerințelor unice ale diverselor tehnologii de mesagerie precum Kafka, MQTT sau WebSockets. De asemenea, susține medii distribuite complexe prin activarea corelării mesajelor la momentul designului și urmărirea expresiilor la runtime pentru o observabilitate îmbunătățită. Proiectul acoperă o suprafață largă de capabilități, incluzând scheme de securitate declarative pentru autentificare și autorizare, precum și modelarea standardizată a datelor folosind formate precum JSON Schema sau Avro. Oferă, de asemenea, mecanisme pentru modularizarea definițiilor mari de API prin componente reutilizabile și registre, ceea ce facilitează guvernanța organizațională și consistența. Specificația este menținută ca un set de fișiere de documentație standardizate, oferind o fundație pentru provizionarea automatizată a infrastructurii și gestionarea topologiilor de rețea bazate pe evenimente.

Aglio este un instrument de tip command-line interface (CLI) și un renderer HTML static conceput pentru a converti fișierele de specificație API Blueprint în documentație web lizibilă. Transformă specificațiile API structurate în pagini HTML standalone care pot fi găzduite și distribuite fără un server backend. Proiectul include un motor de teme care permite personalizarea stilurilor vizuale prin variabile CSS și suprascrierea template-urilor de layout. Utilizatorii pot aplica teme predefinite sau pot integra module externe pentru a schimba modul în care este randată documentația. Instrumentul suportă compunerea modulară a documentelor, permițând fuziunea mai multor fișiere de specificație și markdown într-un singur document folosind includeri de căi relative. Oferă, de asemenea, un server de dezvoltare local cu preview live-reloading pentru a vizualiza modificările randate în timp real.

Input OpenAPI. Output SDKs and Docs.

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.