-
Notifications
You must be signed in to change notification settings - Fork 320
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
7a91207
commit e77cd9c
Showing
2 changed files
with
73 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
# API | ||
|
||
This repository auto-generates the `/db` folder after each commit to `main`. The folder includes two files: | ||
|
||
`categories.json` - A list of all categories | ||
|
||
`resources.json` - A list of all APIs | ||
|
||
You can then use [Octokit](https://github.com/octokit) to fetch the data from the `db` folder. | ||
|
||
Here's a minimal snippet on how to accomplish that: | ||
|
||
```ts | ||
import { Octokit } from 'octokit' | ||
|
||
async function fetchResources(file: string) { | ||
const octokit = new Octokit({ auth: process.env.GITHUB_ACCESS_TOKEN }) | ||
|
||
const { data } = await octokit.rest.repos.getContent({ | ||
owner: 'marcelscruz', | ||
repo: 'public-apis', | ||
path: `/db/${file}.json`, | ||
}) | ||
|
||
if (data.download_url) { | ||
const result = await fetch(data.download_url) | ||
|
||
if (!result.ok) { | ||
throw new Error(`Unexpected response ${result.statusText}`) | ||
} | ||
|
||
return await result.json() | ||
} else { | ||
throw new Error('Download URL not found') | ||
} | ||
} | ||
``` | ||
|
||
The response will be an object with the following structure: | ||
|
||
`categories.json`: | ||
|
||
```ts | ||
{ | ||
"count": number, | ||
"entries": [ | ||
{ | ||
"name": string, | ||
"slug": string | ||
} | ||
] | ||
} | ||
``` | ||
|
||
`resources.json`: | ||
|
||
```ts | ||
{ | ||
"count": number, | ||
"entries": [ | ||
{ | ||
"API": string, | ||
"Auth": string, | ||
"Category": string, | ||
"Cors": string, | ||
"Description": string, | ||
"HTTPS": boolean, | ||
"Link": string, | ||
} | ||
] | ||
} | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters