14 dépôts
Tools and utilities for generating, managing, and serving standardized API documentation and schema definitions.
Distinguishing note: Focuses on the generation and management of API schemas and documentation, distinct from general-purpose API frameworks or runtime communication libraries.
Explore 14 awesome GitHub repositories matching web development · API Documentation Tools. Refine with filters or upvote what's useful.
Twenty is a headless customer relationship management framework that enables developers to build, version, and deploy custom business applications using code. By utilizing a declarative approach to data modeling, the platform allows for the definition of custom objects, fields, and complex relationships directly within the source code. This schema-driven architecture automatically generates corresponding REST and GraphQL APIs, ensuring that data structures and interface components remain synchronized across development and production environments. The platform distinguishes itself through a m
Generates and exposes standardized API schemas to facilitate integration and clear communication between services.
This project is a comprehensive network traffic orchestrator and server infrastructure manager designed to provide centralized control over secure tunneling, routing, and security policies. It functions as a web-based dashboard that enables administrators to deploy and maintain network services, enforce access restrictions, and manage traffic flow through a private server environment. The platform distinguishes itself by integrating advanced traffic anonymization and routing capabilities, including support for relay networks and secure tunnels to bypass regional restrictions. It provides gran
Test and interact with service interfaces using documentation tools that allow you to verify authentication methods and inspect data responses in real time.
Elysia is a high-performance TypeScript web framework designed for building type-safe backend services. It provides a modular, plugin-based architecture that allows developers to compose server logic, middleware, and validation schemas into scalable application instances. By leveraging native web standards, the framework ensures portability across diverse JavaScript runtimes, including Node.js, Deno, and various edge computing environments. The framework distinguishes itself through its focus on end-to-end type safety, automatically synchronizing request and response definitions between the s
Automatically generates interactive API documentation and schema definitions directly from server routes.
Showdoc is a technical documentation platform and knowledge management system designed to centralize project specifications, internal manuals, and technical guides. Built as a PHP web application, it provides a collaborative environment for teams to organize and share information across software development organizations. The platform distinguishes itself through its ability to automate documentation workflows by parsing source code comments and synchronizing technical records with the current state of a codebase. It also features specialized tools for managing RESTful API documentation and g
A centralized repository for documenting RESTful endpoints and data structures to facilitate communication between frontend and backend engineering teams.
Swag is a documentation tool for Go that generates standardized API specification files by parsing declarative annotations within source code. It functions by analyzing source files to extract metadata from comments and function signatures, transforming them into machine-readable formats such as JSON or YAML. This process ensures that technical documentation remains synchronized with the underlying code structure throughout the development lifecycle. The tool distinguishes itself through its ability to perform static source code parsing and type-system reflection, which allows it to map compl
Extracts declarative comments from Go source code to produce machine-readable API documentation.
This framework serves as a bridge between backend services and AI agents by implementing the Model Context Protocol. It enables developers to expose existing application logic and web endpoints as standardized tools, allowing AI models to discover, interact with, and execute backend functions through a unified interface. The project distinguishes itself by automatically converting application request and response models into protocol-compliant schemas, ensuring that AI agents receive accurate functional context. It supports a transport-agnostic architecture that facilitates real-time bidirect
Generates and serves standardized API documentation and schema definitions to provide AI agents with accurate functional context.
swagger-core is a set of libraries for parsing, generating, and serializing OpenAPI specifications to automate REST API documentation. It provides tools to read, validate, and transform JSON or YAML specifications into programmable objects, as well as a generator that scans source code and annotations to create formal technical descriptions of an API. The project enables bi-directional specification serialization, allowing in-memory API definitions to be converted between native language objects and structured files. It uses a plugin-based scanning mechanism and annotation-driven generation t
Provides a complete system for modeling API parameters, response schemas, and server metadata to automate REST documentation.
Hug is a type-driven Python web framework designed for building APIs. It uses Python type annotations to automatically validate and convert incoming request data and to format outgoing responses. The framework functions as an automated documentation tool by extracting function signatures and markers from source code to generate accessible API specifications. It also supports non-blocking coroutines for asynchronous API processing to handle background tasks without interrupting the main request cycle. The project provides capabilities for REST API development, including route mapping, endpoin
Automatically generates standardized API specifications and documentation from source code definitions.
Springfox is a Java library that automatically generates OpenAPI-compliant documentation for Spring-based REST services. It scans Spring controller annotations and model classes at runtime to produce machine-readable API specifications, and bootstraps an interactive Swagger UI interface on application startup for browsing and testing documented endpoints. The project provides a migration path from Swagger 2 to OpenAPI 3, replacing legacy annotations and dependencies with OpenAPI 3 equivalents through a starter dependency and configuration change. It integrates with Spring's application contex
Generates machine-readable API specifications from Spring annotations without requiring manual documentation effort.
Postcat est une plateforme intégrée pour la conception et la documentation d'API, servant de client REST API et de serveur de mock. Elle fournit un espace de travail pour définir les exigences techniques et les schémas de données, permettant aux équipes de développement de s'aligner sur le comportement des interfaces. La plateforme dispose d'une architecture de plugins qui permet l'intégration d'outils tiers et de capacités personnalisées. Elle découple les cycles de développement frontend et backend en générant des réponses serveur simulées basées sur des structures de données prédéfinies. L'ensemble d'outils inclut un système de gestion d'environnement pour basculer entre les configurations de développement, de staging et de production. Il couvre également les tests de requêtes et la validation des réponses pour vérifier que la sortie réseau correspond aux exigences fonctionnelles.
Provides tools for generating and managing standardized API documentation and schema definitions to share usage details.
Swashbuckle.AspNetCore est un outil de spécification d'API et un générateur de documentation pour ASP.NET Core. Il extrait les métadonnées du code source et des modèles pour produire des spécifications OpenAPI standardisées et des interfaces de navigateur interactives pour explorer et tester les API web. Le projet intègre un composant middleware pour servir ces spécifications et une interface Swagger UI pour le test d'API interactif directement depuis une application en cours d'exécution. Il fournit également un exportateur en ligne de commande pour extraire les fichiers de spécification des assemblages d'application pour une utilisation dans les pipelines CI/CD. L'outil couvre un large éventail de capacités incluant la gestion de schéma pour les types complexes, l'annotation de métadonnées via des attributs et des commentaires XML, et la configuration de sécurité pour OAuth 2.0 et les clés API. Il prend en outre en charge la gestion de contrat d'API, le versionnage de spécification et des pipelines de génération personnalisables pour filtrer ou modifier les opérations.
Functions as a comprehensive tool for generating, managing, and serving standardized API documentation and schema definitions.
swagger-php est un générateur de spécifications OpenAPI et une bibliothèque de documentation d'API PHP. Il scanne les attributs et annotations du code source PHP pour produire des fichiers de spécification standardisés et des références d'API interactives. L'outil fonctionne comme un moteur d'inférence de schéma qui dérive les types de données et les schémas à partir des indices de type natifs PHP et des blocs génériques. Il utilise une analyse statique basée sur la réflexion pour extraire des métadonnées sans exécuter la logique d'application et prend en charge l'héritage de schéma récursif pour fusionner les définitions des classes parentes et des interfaces. Le projet inclut un utilitaire en ligne de commande pour exporter les définitions d'API vers des fichiers YAML ou JSON statiques. Il fournit également un pipeline pour l'assemblage de spécifications avec une logique de traitement enfichable pour modifier la façon dont le code source est analysé ou structuré.
Provides tools for generating and serving standardized API documentation and schema definitions from source code.
Flasgger is a documentation framework for Flask applications that generates OpenAPI specifications and an integrated Swagger UI. It functions as a documentation generator and specification parser that extracts API schemas from route definitions, function docstrings, and external specification files. The tool allows API definitions to be maintained either within the source code using YAML blocks in docstrings or decoupled into standalone YAML files. It provides a browser-based interactive console for testing and exploring API endpoints directly from the web application. Beyond documentation,
Functions as a documentation framework that extracts API schemas from Flask route definitions and external files.
utoipa is a Rust API documentation tool used to generate machine-readable OpenAPI specifications. It functions as a specification generator and schema mapper that converts Rust structs and enums into compliant OpenAPI schemas. The project distinguishes itself by using procedural macros and traits to automate metadata extraction from code. It supports complex data modeling, including generics, polymorphism, and recursive type resolution, while synchronizing field renaming and tagging from serialization attributes. It also enables the composition of modular specifications, allowing multiple sma
Provides a complete toolset for creating machine-readable API definitions by mapping Rust types to OpenAPI schemas.