awesome-repositories.com
Blog
awesome-repositories.com

Descoperă cele mai bune repository-uri open source cu căutare AI.

ExploreazăCăutări recomandateAlternative open-sourceSoftware self-hostedBlogHartă site
ProiectDespreCum realizăm clasamentulPresăServer MCP
LegalConfidențialitateTermeni
© 2026 Bringes Technology SRL·VAT RO45896025·hello@awesome-repositories.com
·
apidoc avatar

apidoc/apidocArchived

0
View on GitHub↗
9,667 stele·1,635 fork-uri·JavaScript·8 vizualizăriapidocjs.com↗

Apidoc

apidoc este un generator de documentație API din codul sursă care analizează adnotările specializate din comentarii pentru a crea automat un site de documentație API căutabil. Funcționează ca un parser API bazat pe adnotări și un generator de site-uri de documentație statică, extrăgând definițiile direct din codebase pentru a menține o referință sincronizată.

Instrumentul este conceput ca un parser multi-limbaj, folosind expresii regulate configurabile pentru a extrage metadate din diverse limbaje de programare. Poate servi, de asemenea, ca exportator de definiții API JSON, convertind comentariile din codul sursă în fișiere JSON brute pentru utilizare în scheme externe sau șabloane personalizate.

Dincolo de generarea de bază, sistemul suportă layout-uri de documentație personalizate, filtre de vizibilitate pentru metode private sau depreciate și posibilitatea de a testa endpoint-uri API live direct din interfața generată. Fluxul de lucru poate fi automatizat prin monitorizarea fișierelor sursă pentru modificări, declanșând regenerarea în timp real.

Generatorul poate fi executat prin interfața linie de comandă, rulat programatic ca bibliotecă sau implementat folosind un container Docker.

Features

  • API Documentation Generators - Automatically generates a searchable API documentation website from specialized source code annotations.
  • API Documentation Generators - Parses specialized annotations in source code to automatically generate a searchable API documentation website.
  • Static Site Templating - Transforms structured API data into searchable HTML websites using customizable layout templates.
  • Source Code Documentation Tools - Implements utilities that extract metadata from source code comments to automate the creation of technical API references.
  • Multi-Language API Documentation - Uses configurable regular expressions to parse API metadata across multiple programming languages for consistent documentation.
  • Source Comment Parsers - Extracts API definitions from various programming languages using configurable regular expression matching.
  • Automated API Documentation - Automatically generates searchable technical documentation by extracting API definitions directly from source code annotations.
  • Annotation Parsers - Uses a regex-based parsing system to extract API metadata from comments across various programming languages.
  • Regular Expression-Based Parsing - Uses regular expressions to parse API metadata from source code comments.
  • Document Output Customization - Offers customization of documentation layouts through grouping, manual ordering, and unique headers.
  • Static Site Generators - Transforms parsed API definitions and templates into a searchable static HTML website for web deployment.
  • Static-Site-Based Documentation - Generates a static web interface for browsing API endpoints and testing requests against live servers.
  • Data Export Generators - Exports extracted API definitions into raw JSON files for use in external tools.
  • API Definition Exporters - Converts source-code comments into raw JSON files for use in external schemas or custom templates.
  • Member Visibility Filtering - Controls endpoint visibility in the output using annotations for private or deprecated methods.
  • Source File Watching - Monitors source files for changes to trigger automatic documentation regeneration.
  • Documentation Automation - Includes a file-watching mechanism that triggers automatic regeneration of documentation whenever source files are updated.
  • Intermediate Representations - Uses a JSON intermediate representation to decouple API extraction from site rendering.
  • API Endpoint Testing - Provides an interface to execute sample requests and verify live API endpoint behaviors.
  • Documentation Layouts - Supports custom documentation layouts, grouping, and visibility filters to tailor the organization of the generated API reference.
  • Documentation Generators - Generates RESTful API documentation from source code annotations.

Istoric stele

Graficul istoricului de stele pentru apidoc/apidocGraficul istoricului de stele pentru apidoc/apidoc

Căutare AI

Explorează mai multe repository-uri excelente

Descrie ce ai nevoie în limbaj simplu — AI-ul sortează mii de proiecte open source selectate în funcție de relevanță.

Start searching with AI

Alternative open-source pentru Apidoc

Proiecte open-source similare, clasificate după numărul de funcționalități comune cu Apidoc.
  • typestrong/typedocAvatar TypeStrong

    TypeStrong/typedoc

    8,411Vezi pe GitHub↗

    TypeDoc is a documentation generator and AST analyzer that transforms TypeScript source code and comments into structured API reference websites or data files. It functions as a static site generator that converts code symbols into a searchable web interface. The project is an extensible framework, allowing users to modify the documentation process and generator logic through a programmable plugin system and custom themes. Its capabilities include API reference generation, source code parsing, and documentation coverage validation to ensure exported members are properly described. It support

    TypeScriptdocumentationgeneratortypescript
    Vezi pe GitHub↗8,411
  • tomaz/appledocAvatar tomaz

    tomaz/appledoc

    4,189Vezi pe GitHub↗

    Appledoc is an Objective-C documentation generator and static site generator that parses source code comments to create structured HTML documentation sets. Its primary purpose is to generate professional developer reference guides that adhere to official Apple style documentation. The tool distinguishes itself by integrating directly into the project compilation process via automated build-phase scripts, ensuring that technical guides are updated as code changes. It provides extensive customization through external HTML and CSS templates, as well as a property list configuration system to man

    Objective-C
    Vezi pe GitHub↗4,189
  • lord/slateAvatar lord

    lord/slate

    36,082Vezi pe GitHub↗

    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

    Vezi pe GitHub↗36,082
  • kotlin/dokkaAvatar Kotlin

    Kotlin/dokka

    3,780Vezi pe GitHub↗

    Dokka is an extensible documentation engine designed to generate structured API reference materials for Kotlin projects. By parsing source code and comments, it functions as a static site generator that transforms codebases into readable documentation. It integrates directly into development workflows as a build system plugin, allowing for the automated creation of reference materials during the standard compilation process. The project distinguishes itself through a modular, plugin-driven processing pipeline that allows developers to modify the generation workflow, customize output formats,

    Kotlinapi-referencedocumentationdokka
    Vezi pe GitHub↗3,780
Vezi toate cele 30 alternative pentru Apidoc→

Întrebări frecvente

Ce face apidoc/apidoc?

apidoc este un generator de documentație API din codul sursă care analizează adnotările specializate din comentarii pentru a crea automat un site de documentație API căutabil. Funcționează ca un parser API bazat pe adnotări și un generator de site-uri de documentație statică, extrăgând definițiile direct din codebase pentru a menține o referință sincronizată.

Care sunt principalele funcționalități ale apidoc/apidoc?

Principalele funcționalități ale apidoc/apidoc sunt: API Documentation Generators, Static Site Templating, Source Code Documentation Tools, Multi-Language API Documentation, Source Comment Parsers, Automated API Documentation, Annotation Parsers, Regular Expression-Based Parsing.

Care sunt câteva alternative open-source pentru apidoc/apidoc?

Alternativele open-source pentru apidoc/apidoc includ: typestrong/typedoc — TypeDoc is a documentation generator and AST analyzer that transforms TypeScript source code and comments into… tomaz/appledoc — Appledoc is an Objective-C documentation generator and static site generator that parses source code comments to… lord/slate — Slate is a static API documentation generator and developer documentation framework. It transforms API specifications… kotlin/dokka — Dokka is an extensible documentation engine designed to generate structured API reference materials for Kotlin… jsdoc/jsdoc — JSDoc is a JavaScript API documentation generator that parses comments in source code to produce structured… voltagent/awesome-claude-code-subagents — This project provides a framework for managing multi-agent systems, designed to automate complex software development,…