Skip to main content

API Cards

WriteDocs API Cards gives you an ideal way to present your endpoints, creating cards for each endpoint, highlighting their method.

Get Items

GET

This example demonstrates how to use a API card for a GET endpoint.

Create Item

POST

This example demonstrates how to use a API card for a POST endpoint.

Update Item

PUT

This example demonstrates how to use a API card for a PUT endpoint.

Patch Item

PATCH

This example demonstrates how to use a API card for a PATCH endpoint.

Delete Item

DELETE

This example demonstrates how to use a API card for a DELETE endpoint.

Code for API Cards
<APICard 
  title="Get Items"
  description="This example demonstrates how to use a API card for a GET endpoint."
  link="/get-items"
  type="get"
/>

// or

<APICard 
  title="Get Items"
  link="/get-items"
  type="get"
>
  This example demonstrates how to use a API card for a `GET` endpoint.
</APICard>

Attributes​

title string required
The title displayed on the card.

description string
A brief explanation of the card's purpose and behavior, shown beneath the title.

link string
The URL or path the Card links to when clicked.

type string required
The endpoint's method. Possible Values: GET, POST, PUT, DELETE, PATCH.

Just like regular cards, API cards can be used inside the <CardList> component, displaying them side by side in a grid layout.

You can mix both <Cards> and <APICards> inside a <CardList> component.