qyg2297248353/svgl
qyg2297248353/svgl
1
0
Fork 0
mirror of https://github.com/pheralb/svgl.git synced 2024-09-20 11:16:19 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

📄 Update api docs with new api route

Browse Source
This commit is contained in:
pheralb 2024-08-20 19:16:36 +01:00
parent 2138c8b410
commit 9080802c3e
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/docs/api.md
View File

@ -20,9 +20,9 @@ The API is currently open to everyone and does not require any authentication. H
The base URL for the API is: The base URL for the API is:
```bash ```bash
https://svgl.app/api/svgs https://api.svgl.app
# or # or
https://svgl.app/api/categories https://api.svgl.app/categories
``` ```
## Typescript usage ## Typescript usage
@ -59,7 +59,7 @@ export interface iSVG {
<Endpoint title="Get all SVGs" method="GET" description="Returns all the SVGs in the repository."> <Endpoint title="Get all SVGs" method="GET" description="Returns all the SVGs in the repository.">
```bash ```bash
/api/svgs https://api.svgl.app
``` ```
<p></p> <p></p>
@ -83,7 +83,7 @@ export interface iSVG {
<Endpoint title="Get a limited number of SVGs" method="GET" description="Returns a limited number of SVGs in the repository. Start from the first SVG."> <Endpoint title="Get a limited number of SVGs" method="GET" description="Returns a limited number of SVGs in the repository. Start from the first SVG.">
```bash ```bash
/api/svgs?limit=10 https://api.svgl.app?limit=10
``` ```
<p></p> <p></p>
@ -107,7 +107,7 @@ export interface iSVG {
<Endpoint title="Filter SVGs by category" method="GET" description="Returns all the SVGs in the repository that match the category."> <Endpoint title="Filter SVGs by category" method="GET" description="Returns all the SVGs in the repository that match the category.">
```bash ```bash
/api/svgs?category=software https://api.svgl.app/category/software
``` ```
<p></p> <p></p>
@ -133,7 +133,7 @@ The list of categories is available [here](https://github.com/pheralb/svgl/blob/
<Endpoint title="Get only categories" method="GET" description="Returns only categories with the number of SVGs in each category."> <Endpoint title="Get only categories" method="GET" description="Returns only categories with the number of SVGs in each category.">
```bash ```bash
/api/categories https://api.svgl.app/categories
``` ```
<p></p> <p></p>
@ -158,7 +158,7 @@ The list of categories is available [here](https://github.com/pheralb/svgl/blob/
<Endpoint title="Search SVGs by name" method="GET" description="Returns all the SVGs in the repository that match the name."> <Endpoint title="Search SVGs by name" method="GET" description="Returns all the SVGs in the repository that match the name.">
```bash ```bash
/api/svgs?search=axiom https://api.svgl.app?search=axiom
``` ```
<p></p> <p></p>