13 个仓库
Tools for designing, validating, and converting API definition files.
Explore 13 awesome GitHub repositories matching part of an awesome list · API Specification Tools. Refine with filters or upvote what's useful.
The OpenAPI Specification is a formal, vendor-neutral standard for defining the structure, endpoints, and data models of HTTP-based web services. By providing a machine-readable interface definition language, it enables developers to establish clear API contracts that ensure consistency across diverse programming languages and backend systems. This specification promotes a design-first development approach, where interface behavior is defined through static, declarative configuration files rather than imperative code. This structure allows for the automated generation of type-safe client libr
Official standard for defining RESTful APIs.
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
Generates interactive API reference documentation from specifications.
eShop is a .NET microservices reference application that provides a comprehensive blueprint for a distributed retail system. It implements an e-commerce architecture using decoupled services to manage core operations such as product catalogs, shopping baskets, and order processing. The project demonstrates a cloud-native retail infrastructure that incorporates an asynchronous event bus system to synchronize state across distributed services. It includes a reference implementation for integrating generative AI features by connecting the store to large language models via cloud providers. The
Includes tooling to validate API specifications, ensuring consistent responses and parameter descriptions.
api-blueprint is a markdown-based API design language and specification standard used to define the structure, behavior, and data schemas of HTTP web services. It provides a formal method for mapping HTTP methods to resources and defining payload validation rules through a machine-readable syntax. The project functions as a blueprint for creating interactive technical documentation and functional mock servers. These tools transform design specifications into human-readable guides and simulated backend environments to enable integration testing before implementation. The language covers API m
A markdown-based language for describing web APIs.
openapi-devtools 是一个浏览器扩展和 OpenAPI 规范生成器,可捕获网络流量以自动记录网站和应用程序的 API 结构。它充当 HTTP 流量捕获器和基于浏览器的文档工具,将实时网络请求映射为标准化的 API 规范。 该工具通过拦截出站 HTTP 流量并使用基于启发式的合并方法,将来自多个请求的标头、主体和参数组合成统一的端点定义,从而实现 API 逆向工程。这些捕获的定义可以在浏览器中可视化为人类可读的文档,或导出为可下载的文件和可共享的字符串。 该项目涵盖了网络请求映射的全流程,从客户端规范生成和基于状态的持久化,到最终的 API 定义导出。
Generates API specifications directly from browser traffic.
Dredd 是一个 HTTP API 合约测试工具和规范验证器。它作为一个自动化测试运行器,验证实时后端服务器的行为是否符合正式的 API 规范文档。 该系统通过将规范定义转换为 HTTP 请求,并将生成的响应与定义的 JSON 模式进行匹配,执行语言无关的 API 测试。此过程确保服务器实现无论使用何种编程语言构建,都能保持与设计合约的一致性。 该工具通过编排外部设置和清理脚本来管理测试生命周期。这些语言无关的钩子(hooks)允许配置测试环境并在各个验证测试之间维护状态。
Validates API documentation against backend implementations.
Spectral is a programmable linting engine and validation tool designed to enforce style guidelines and schema correctness within OpenAPI specifications and JSON configuration files. It functions as a rule-based validator that analyzes structured text files to ensure data consistency and adherence to predefined constraints. The engine utilizes a configuration-driven execution model, allowing users to manage pluggable rule sets and integrate JSON Schema definitions. It supports the creation of custom function-based rules to define complex validation logic beyond static declarations. The projec
Lints YAML or JSON files against custom rulesets.
This project provides a web-based integrated development environment for defining, documenting, and simulating software interface specifications. It serves as a browser-based modeling tool that enables teams to create structured API contracts using the RAML modeling language. The environment distinguishes itself through its modular design, which allows the modeling interface to be embedded directly into existing web applications and developer portals. It supports a plugin architecture that enables the integration of custom persistence layers and metadata handlers, allowing teams to attach pro
Provides a browser-based interface for defining software interface structures and generating machine-readable documentation.
Swagger Search is an application that aggregates the Swagger/OpenAPI documentation of your microservice architecture in one place, where your can browse it or search endpoints based on their url, documentation, the parameters it accepts or their types.
Indexes and discovers API definitions within microservice architectures.
This SwaggerProvider can be used to access RESTful API generated using Swagger.io
Provides F# type-safe access to API definitions.
A JSON schema validator for OpenAPI specifications, it currently supports:
Validates API schemas against official specification versions.
Parses Swagger specs in JSON or YAML format - Validates against the Swagger 2.0 schema or OpenAPI 3.0 Schema - Resolves all $ref pointers, including external files and URLs - Can bundle all your Swagger files into a single file that only has internal $ref pointers - Can dereference all $ref…
Parses and validates API definitions in Node and browsers.
A module to build validators for Swagger(OpenApi) Request parameters and Response objects.
Builds validators for API request and response parameters.