swagger-api/swagger-ui
Swagger Ui
Swagger UI is an OpenAPI specification renderer and documentation interface that transforms JSON or YAML API definitions into a navigable, searchable website. It functions as an OpenAPI documentation UI and request client, providing a visual catalog for exploring endpoints and sending live HTTP requests to a server using a schema-defined interface.
The project distinguishes itself through a plugin-based extension system and a schema-driven UI generation model. This architecture allows for the injection of custom components, state selectors, and helper functions to modify core behavior and layout, as well as the use of a request pipeline to intercept and modify network traffic.
The system covers a broad range of capabilities, including OAuth 2.0 authorization management for protected resources, API operation filtering, and deep linking to specific operations via URL fragments. It supports various delivery methods, including static asset distribution, HTML embedding as a React component, and containerized deployment.
Features
- API Request Clients - Functions as a browser-based request client to send live HTTP requests and verify server responses.
- Interactive Documentation Interfaces - Transforms API specifications into an interactive web interface for exploring and testing resources.
- API Documentation - Generating a visual interface from OpenAPI specifications so developers can explore endpoints and requirements.
- Visual Specification Renderers - Transforms API definition files into a browsable catalog of resources for developer onboarding.
- API Specification UI Rendering - Renders OpenAPI specifications into an interactive visual catalog for exploring and testing endpoints.
- OAuth Authentication - Provides a UI for configuring client IDs and scopes to authorize requests via OAuth 2.0.
- OAuth Providers - Manages client credentials and security flows to authorize requests against protected resources.
- Schema-Driven Generators - Transforms OpenAPI specification files into a visual, interactive user interface by mapping schemas to components.
- Hook-Based Plugin Systems - Provides a plugin system allowing the injection of custom components and logic into interface injection points.
- API Endpoint Testing - Allows users to send live HTTP requests with custom headers to verify server responses in real time.
- Interface Plugin Architectures - Implements a UI-level plugin architecture for injecting custom scripts and components to modify behavior.
- API Request Configurations - Attaches security credentials, custom headers, and API keys to outgoing requests.
- API Specification Loading - Supports fetching API definitions from remote URLs or local objects during runtime for dynamic rendering.
- HTTP Request Clients - Functions as a browser-based tool for sending live HTTP requests using a schema-defined interface.
- State Namespace Extensions - Allows plugins to define new state namespaces and reducers to manage custom data within the runtime.
- Containerized Deployments - Ships as a pre-configured Docker image for consistent deployment across environments.
- API Reference Hosting - Supports hosting the interactive reference interface as a static site or within Docker containers.
- Traffic Interception Tools - Includes a request pipeline to intercept and modify outgoing requests and incoming responses.
- Request Interceptors - Implements middleware hooks in the request pipeline to modify headers and payloads of network calls.
- Logic Overrides - Provides a plugin system that allows wrapping actions and selectors to conditionally override core logic.
- Centralized State Stores - Utilizes a centralized Redux store to track API definitions, authentication states, and UI configurations.
- Custom Components - Allows registering and replacing interface elements with custom component implementations.
- Static Asset Distributions - Provides a dependency-free distribution of static assets for flexible hosting integration.
- Containerized Documentation - Provides a containerized distribution of static assets and a web server for deploying API references.
- UI Component Embedding - Allows integrating the API reference directly into web pages using a CDN or static asset files.
- API Design Tools - Generates interactive documentation from Swagger-compliant API definitions.
- API Development - Displays generated API documentation.
- API Documentation - Dynamically generates documentation from Swagger APIs.
- Notes and Documentation - Tool for generating documentation from Swagger-compliant APIs.
