Branding Customization
You can customize or hide the default Powered by VitePress OpenAPI
branding that appears at the bottom of vitepress-openapi
components.
Support the Project
Please show your support for this project by giving a star on GitHub and/or sponsoring Enzo Notario, the maintainer of this project.
Hiding the Branding
The simplest way to hide the branding is to use the hide-branding
prop on the OASpec
or OAOperation
components:
Example
---
aside: false
outline: false
title: vitepress-openapi
---
<OAOperation operationId="getAllArtists" hide-branding />
[//]: # (Or if using OASpec:)
[//]: # (<OASpec hide-branding />)
Preview
Get all artists
Get a list of all legendary Argentine Rock artists and explore their contributions to the music scene. You can get one using the GETGet an artist endpoint.
Parameters
Query Parameters
The number of items to return
10
20
50
"int64"
10
The number of items to skip before starting to collect the result set
1
23
456
"int64"
0
Responses
Success Response
The request was successful and returns a list of artists.
Response Format
The response includes:
- A
data
array containing artist objects - Pagination information
Note: You can use the pagination parameters to navigate through large result sets.
Custom Branding with Slots
For more control, you can replace the default branding with your own content using the branding
slot:
Example
---
aside: false
outline: false
title: vitepress-openapi
---
<OAOperation operationId="getAllArtists">
<template #branding>
<div class="my-custom-branding">
Powered by My Company
</div>
</template>
</OAOperation>
[//]: # (Or if using OASpec:)
[//]: # (<OASpec>)
[//]: # ()
[//]: # (<template #branding>)
[//]: # ( <div class="my-custom-branding">)
[//]: # ( Powered by My Company)
[//]: # ( </div>)
[//]: # (</template>)
[//]: # ()
[//]: # (</OASpec>)
Preview
Get all artists
Get a list of all legendary Argentine Rock artists and explore their contributions to the music scene. You can get one using the GETGet an artist endpoint.
Parameters
Query Parameters
The number of items to return
10
20
50
"int64"
10
The number of items to skip before starting to collect the result set
1
23
456
"int64"
0
Responses
Success Response
The request was successful and returns a list of artists.
Response Format
The response includes:
- A
data
array containing artist objects - Pagination information
Note: You can use the pagination parameters to navigate through large result sets.