Expand description
OpenAPI specification viewer components.
This module provides components for rendering OpenAPI 3.0/3.1 specifications with interactive endpoint documentation.
Structs§
- ApiInfo
Header Props - Props for ApiInfoHeader component.
- Endpoint
Card Props - Props for EndpointCard component.
- Endpoint
Page Props - Props for EndpointPage component.
- Method
Badge Props - Props for MethodBadge component.
- Open
ApiViewer Props - Props for OpenApiViewer component.
- Parameter
Item Props - Props for ParameterItem component.
- Parameters
List Props - Props for ParametersList component.
- Request
Body Section Props - Props for RequestBodySection component.
- Response
Item Props - Props for ResponseItem component.
- Responses
List Props - Props for ResponsesList component.
- Schema
Definitions Props - Props for SchemaDefinitions component.
- Schema
Type Label Props - Props for SchemaTypeLabel component.
- Schema
Viewer Props - Props for SchemaViewer component.
- TagGroup
Props - Props for TagGroup component.
- Ungrouped
Endpoints Props - Props for UngroupedEndpoints component.
Functions§
- ApiInfo
Header - API information header with title, version, and servers.
- Endpoint
Card - Collapsible card for an API endpoint.
- Endpoint
Page - Full-page two-column layout for a single API endpoint.
- Method
Badge - Colored badge for HTTP methods.
- Open
ApiViewer - Main OpenAPI specification viewer.
- Parameter
Item - Single parameter item.
- Parameters
List - List of API parameters with type info.
- Request
Body Section - Request body schema viewer.
- Response
Item - Single response item with collapsible content.
- Responses
List - List of API responses with status codes.
- Schema
Definitions - Schema definitions section.
- Schema
Type Label - Simple type label without expand/collapse.
- Schema
Viewer - Recursive schema viewer with expand/collapse for complex types.
- TagGroup
- Group of endpoints under a tag heading.
- Ungrouped
Endpoints - Endpoints that don’t belong to any tag.