mirror of
https://github.com/pheralb/svgl.git
synced 2025-04-07 16:58:12 +08:00
📝 Update API docs
This commit is contained in:
parent
ed61a22ab0
commit
57054acf25
@ -5,6 +5,7 @@ description: The API reference is a detailed documentation of all the endpoints
|
||||
|
||||
<script>
|
||||
import Endpoint from '../components/endpoints.svelte';
|
||||
import Alert from '../ui/alert/alert-component.svelte';
|
||||
</script>
|
||||
|
||||
## Introduction
|
||||
@ -15,6 +16,10 @@ SVGL API is a RESTFul API that allows you to get all the information of the SVGs
|
||||
|
||||
The API is currently open to everyone and does not require any authentication. However, to prevent abusive use of the API, there is a limit to the number of requests.
|
||||
|
||||
<Alert type="info">
|
||||
Don't use the API for create the same product as SVGL. The API is intended to be used for extensions, plugins, or other tools that can help the community.
|
||||
</Alert>
|
||||
|
||||
## Base URL
|
||||
|
||||
The base URL for the API is:
|
||||
@ -55,6 +60,8 @@ export interface iSVG {
|
||||
}
|
||||
```
|
||||
|
||||
- `tCategory` is a large list of categories that can be found [here](https://github.com/pheralb/svgl/blob/main/src/types/categories.ts#L1).
|
||||
|
||||
## Endpoints
|
||||
|
||||
<Endpoint title="Get all SVGs" method="GET" description="Returns all the SVGs in the repository.">
|
||||
|
Loading…
x
Reference in New Issue
Block a user