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, इवेंट-ड्रिवन इंटरफेस और एसिंक्रोनस मैसेज-आधारित आर्किटेक्चर को परिभाषित और डॉक्यूमेंट करने के लिए एक मशीन-रीडेबल स्पेसिफिकेशन स्टैंडर्ड है। यह डिस्ट्रिब्यूटेड सिस्टम्स की संरचना को मॉडल करने के लिए एक यूनिफाइड फ्रेमवर्क प्रदान करता है, जिसमें सर्वर्स, चैनल्स, मैसेज और ऑपरेशन्स की परिभाषा शामिल है। यह स्पेसिफिकेशन अपने प्रोटोकॉल-अग्नोस्टिक डिज़ाइन के कारण अलग है, जो कोर इंटरफेस डेफिनिशन को ट्रांसपोर्ट-विशिष्ट कॉन्फ़िगरेशन से अलग करता है। इससे डेवलपर्स Kafka, MQTT या WebSockets जैसी विभिन्न मैसेजिंग तकनीकों की आवश्यकताओं को पूरा करते हुए 'सिंगल सोर्स ऑफ ट्रुथ' बनाए रख सकते हैं। यह डिज़ाइन-टाइम मैसेज कोरिलेशन और रनटाइम एक्सप्रेशन ट्रैकिंग के माध्यम से बेहतर ऑब्जर्वेबिलिटी भी प्रदान करता है। इसमें ऑथेंटिकेशन और ऑथोराइजेशन के लिए डिक्लेरेटिव सिक्योरिटी स्कीमा और JSON Schema या Avro जैसे स्टैंडर्ड डेटा मॉडलिंग शामिल हैं।

Aglio एक कमांड-लाइन इंटरफ़ेस टूल और स्टैटिक HTML रेंडरर है जिसे API Blueprint स्पेसिफिकेशन फाइलों को पठनीय, वेब-आधारित डॉक्यूमेंटेशन में बदलने के लिए डिज़ाइन किया गया है। यह स्ट्रक्चर्ड API स्पेसिफिकेशन्स को स्टैंडअलोन HTML पेजों में बदलता है जिन्हें बिना बैकएंड सर्वर के होस्ट और वितरित किया जा सकता है। इस प्रोजेक्ट में एक थीम इंजन शामिल है जो CSS वेरिएबल्स और लेआउट टेम्पलेट ओवरराइड्स के माध्यम से विज़ुअल स्टाइल्स के कस्टमाइज़ेशन की अनुमति देता है। यूज़र्स इन-बिल्ट थीम्स लागू कर सकते हैं या डॉक्यूमेंटेशन को रेंडर करने के तरीके को बदलने के लिए बाहरी मॉड्यूल्स को एकीकृत कर सकते हैं। यह टूल मॉड्यूलर डॉक्यूमेंट कंपोज़िशन का समर्थन करता है, जो रिलेटिव पाथ इनक्लूजन का उपयोग करके कई स्पेसिफिकेशन और मार्कडाउन फाइलों को एक ही डॉक्यूमेंट में मर्ज करने में सक्षम बनाता है। यह रेंडर किए गए परिवर्तनों को रियल-टाइम में देखने के लिए लाइव-रीलोडिंग प्रीव्यू के साथ एक लोकल डेवलपमेंट सर्वर भी प्रदान करता है।

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.