13 dépôts
Technical specifications and interface definitions for software libraries.
Distinguishing note: Focuses on the documentation of APIs rather than general technical writing.
Explore 13 awesome GitHub repositories matching development tools & productivity · API Documentation. Refine with filters or upvote what's useful.
yapi is an API management platform designed to coordinate the development of RESTful APIs between frontend, backend, and quality assurance teams. It functions as a centralized system for documenting interface specifications, simulating server responses, and validating requests through a built-in testing client. The platform features an API code generator that transforms interface specifications into typed request functions and data models across multiple programming languages. It also includes a mock server capable of generating synthetic responses using schema-based generators and rule-based
Provides a platform for creating and maintaining visual specifications for API endpoints to coordinate development.
This project serves as a community-maintained repository of documentation for the internal application programming interfaces used by the Bilibili video platform. It provides a structured reference for developers to understand service endpoints, request parameters, and data structures that are not officially documented. The collection relies on reverse-engineered network traffic analysis to map how client applications communicate with backend infrastructure. By decoding these proprietary protocols, the project offers a unified interface that allows developers to build third-party clients, agg
Provides a comprehensive collection of internal API endpoints, request parameters, and data structures for platform integration.
Swift Evolution serves as the central governance and design platform for the Swift programming language. It provides a structured, collaborative framework for tracking, discussing, and managing the formal proposals and technical goals that define the language's syntax, semantics, and core features. By maintaining a comprehensive collection of design documentation, the project ensures the long-term stability and consistency of the language as it matures. The repository acts as the primary hub for the language's evolution, coordinating community feedback and technical decisions through a transp
Requires descriptive comments for all entities to clarify functionality and usage for developers.
Hammerspoon is a programmable automation engine for macOS that enables deep system-level control through a Lua scripting environment. By bridging high-level scripts with native Objective-C APIs, it allows users to interact with the operating system's accessibility tree, intercept hardware input streams, and manage the lifecycle of running applications. The project distinguishes itself through an event-driven architecture that registers asynchronous hooks for system notifications and hardware events. This allows for real-time automation, such as remapping keyboard and mouse inputs, managing wi
Includes built-in documentation servers to assist developers with script and API reference.
This project is a comprehensive collection of web development reference guides and technical cheat sheets. It provides a curated set of markdown-based documentation designed to help developers quickly locate syntax patterns and API examples for common web technologies and programming languages. The repository serves as a specialized reference library covering several distinct technical domains. It includes extensive guides for CSS, focusing on selectors, Flexbox, Grid, and responsive layout properties, as well as a DevOps command reference for Docker, Kubernetes, AWS, Ansible, and general she
Supplies technical reference sheets for GraphQL schemas, HTTP headers, and RESTful API patterns.
Gorilla is a foundational infrastructure framework for large language model function calling. It provides a system for training, evaluating, and executing the translation of natural language instructions into accurate API calls and executable code. The project integrates a structured API documentation index, a fine-tuning pipeline for model adaptation, and a secure sandboxed action runtime for executing model-generated commands. The framework distinguishes itself through a specialized evaluation benchmark suite that measures the accuracy, cost, and latency of function calls. It includes tools
Organizes and maintains searchable API definitions to improve the training and inference of function calling models.
Swagger Editor est un outil de création web et un environnement de développement utilisé pour concevoir, documenter et valider les spécifications d'API. Il prend spécifiquement en charge la spécification OpenAPI, fournissant une interface de navigateur pour écrire des schémas d'API et vérifier leur structure. L'outil dispose d'un rendu en temps réel qui produit une prévisualisation visuelle de la documentation API au fur et à mesure que la spécification est éditée. Il inclut une coloration syntaxique basée sur des schémas standardisés pour améliorer la lisibilité des définitions d'API. L'éditeur prend en charge l'importation de spécifications à partir de fichiers, d'URLs externes ou de fixtures d'exemple et persiste l'état actuel dans le stockage local pour éviter la perte de données. Il est distribué sous forme d'image conteneur, incluant une version non-root pour réduire la surface d'attaque lors du déploiement.
Facilitates the authoring and visualization of technical API specifications and interface definitions.
This project is an interactive programming education resource and tutorial designed for learning the Rust programming language and systems programming concepts. It provides a collection of runnable and editable code examples that serve as a practical reference for language syntax and implementation. The resource features an interactive code sandbox that allows users to execute and test code snippets in real time. It emphasizes the verification of technical accuracy by executing embedded code blocks during the build process to ensure all examples remain functional. The content covers a compre
Provides a practical reference and technical specifications for Rust APIs using verified executable examples.
This project is a documentation best practices guide and a technical documentation framework focused on creating high-quality project README files. It provides a set of structural principles and a README writing guide to improve project discoverability and usability for open source contributors. The framework employs a cognitive funneling structure to organize information from high-level summaries down to deep technical details. It includes a standardized documentation quality checklist to audit technical documents for essential elements, such as license information and installation steps. T
Provides design principles for formatting API references and technical specifications to increase accessibility.
Serves as the official reference documentation for the Discord API covering bots, webhooks, and gateway events.
Scala 3 is an open-source, statically typed programming language that compiles to JVM bytecode, combining object-oriented and functional programming paradigms. Its core identity is defined by a sophisticated type system that includes traits, generics, union types, and a dependent object type system where types can depend on runtime values through path-dependent and singleton types. The language distinguishes itself through several advanced type-level and metaprogramming capabilities. It features a contextual abstraction mechanism using given instances and using clauses for compile-time implic
Ships searchable API documentation for every version of the standard library.
Aglio est un outil en ligne de commande et un moteur de rendu HTML statique conçu pour convertir les fichiers de spécification API Blueprint en documentation web lisible. Il transforme des spécifications d'API structurées en pages HTML autonomes qui peuvent être hébergées et distribuées sans serveur backend. Le projet inclut un moteur de thèmes qui permet la personnalisation des styles visuels via des variables CSS et des surcharges de modèles de mise en page. Les utilisateurs peuvent appliquer des thèmes intégrés ou intégrer des modules externes pour modifier la façon dont la documentation est rendue. L'outil prend en charge la composition de documents modulaires, permettant la fusion de plusieurs fichiers de spécification et Markdown en un seul document via des inclusions de chemins relatifs. Il fournit également un serveur de développement local avec un aperçu en temps réel pour visualiser les changements rendus.
Provides technical specifications and visual styling for API documentation using themes and CSS.
This project is a comprehensive Python style guide and technical reference designed to promote the creation of clean, maintainable, and idiomatic code. It provides a set of opinionated guidelines and architectural patterns focusing on functional and declarative programming to reduce complexity and improve overall code quality. The guide establishes specific standards for naming conventions, module organization, and project layout. It emphasizes reducing object coupling by favoring modules and functions over deep class hierarchies and offers technical standards for writing docstrings and marku
Defines technical specifications and interface descriptions for software libraries via standardized docstrings.