13 repositorios
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 es una extensión de navegador y generador de especificaciones OpenAPI que captura el tráfico de red para documentar automáticamente las estructuras de API de sitios web y aplicaciones. Funciona como un capturador de tráfico HTTP y una herramienta de documentación basada en navegador, mapeando solicitudes de red en tiempo real a especificaciones de API estandarizadas. La herramienta permite la ingeniería inversa de API al interceptar el tráfico HTTP saliente y utilizar una fusión basada en heurística para combinar encabezados, cuerpos y parámetros de múltiples solicitudes en definiciones de endpoints unificadas. Estas definiciones capturadas pueden visualizarse como documentación legible por humanos dentro del navegador o exportarse como archivos descargables y cadenas compartibles. El proyecto cubre el flujo de trabajo completo de mapeo de solicitudes de red, desde la generación de especificaciones del lado del cliente y la persistencia basada en estado hasta la exportación final de la definición de la API.
Generates API specifications directly from browser traffic.
Dredd es una herramienta de pruebas de contrato de API HTTP y validador de especificaciones. Funciona como un ejecutor de pruebas automatizado que verifica si el comportamiento de un servidor backend en vivo se adhiere a un documento de especificación de API formal. El sistema realiza pruebas de API agnósticas al lenguaje transformando las definiciones de especificación en solicitudes HTTP y comparando las respuestas resultantes con los esquemas JSON definidos. Este proceso asegura que la implementación del servidor permanezca conforme al contrato de diseño independientemente del lenguaje de programación utilizado para construir el backend. La herramienta gestiona el ciclo de vida de las pruebas mediante la orquestación de scripts externos de configuración y limpieza (setup y teardown). Estos hooks agnósticos al lenguaje permiten la configuración del entorno de prueba y el mantenimiento del estado entre pruebas de validación individuales.
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.