Endpoint Collection
List of Endpoints
Overview
This componenent is summary of endpoints for docs pages. It contains clickable links that redirect to SwaggerHub.
Details
Criteria | Component Meets Criteria |
---|---|
Has hover styles | Yes |
Has light and dark mode | Yes |
Has brand theming | No |
Component Props
Prop Name | Type | Description |
---|---|---|
endpoints | array | An array that contains objects containing a category name and array of endpoints |
Example Code
import EndpointCollection from '@site/src/elements/EndpointCollection';
<EndpointCollection
endpoints={[
{
category: 'General',
items: [
{
url: './',
method: 'get',
title: 'Endpoint 1',
},
{
url: './',
method: 'delete',
title: 'Endpoint 2',
},
{
url: './',
method: 'put',
title: 'Endpoint 3',
},
{
url: './',
method: 'post',
title: 'Endpoint 4',
},
],
}
]}
/>