mirror of
https://github.com/upscayl/upscayl.git
synced 2025-01-24 07:04:07 +01:00
34 lines
875 B
Plaintext
34 lines
875 B
Plaintext
---
|
|
title: 'Introduction'
|
|
description: 'Example section for showcasing API endpoints'
|
|
---
|
|
|
|
<Note>
|
|
If you're not looking to build API reference documentation, you can delete
|
|
this section by removing the api-reference folder.
|
|
</Note>
|
|
|
|
## Welcome
|
|
|
|
There are two ways to build API documentation: [OpenAPI](https://mintlify.com/docs/api-playground/openapi/setup) and [MDX components](https://mintlify.com/docs/api-playground/mdx/configuration). For the starter kit, we are using the following OpenAPI specification.
|
|
|
|
<Card
|
|
title="Plant Store Endpoints"
|
|
icon="leaf"
|
|
href="https://github.com/mintlify/starter/blob/main/api-reference/openapi.json"
|
|
>
|
|
View the OpenAPI specification file
|
|
</Card>
|
|
|
|
## Authentication
|
|
|
|
All API endpoints are authenticated using Bearer tokens and picked up from the specification file.
|
|
|
|
```json
|
|
"security": [
|
|
{
|
|
"bearerAuth": []
|
|
}
|
|
]
|
|
```
|