NotAShelf/catApi
1
0
Fork 0
mirror of https://github.com/NotAShelf/catApi.git synced 2024-11-22 23:50:41 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

improve styling

Browse source
This commit is contained in:
raf 2022-01-25 16:00:54 +03:00 committed by GitHub
parent 88ac00a3b4
commit 22f72afadc
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -1,4 +1,5 @@
# 🐾 catApi # 🐾 catApi
> **catApi** is *scuffed* website (fully equipped with an API, obviously) to display pictures of cats from the `/images/` directory > **catApi** is *scuffed* website (fully equipped with an API, obviously) to display pictures of cats from the `/images/` directory
which are supplied by the kind people who sent me pictures of their cats, and also my own. More cats are always welcome in the paw zone. which are supplied by the kind people who sent me pictures of their cats, and also my own. More cats are always welcome in the paw zone.
###### I was initially going to name this project "Onlypaws" but I am too lazy to implement a donation system. ###### I was initially going to name this project "Onlypaws" but I am too lazy to implement a donation system.
@ -50,16 +51,18 @@ and thus, we are currently on the V1 branch. V2 will *probably* introduce proper
TODO TODO
## API Documentation (WIP) ## API Documentation (WIP)
* **`/api/id`**
#### `/api/id`
> return data about the specified image, by ID > return data about the specified image, by ID
> - **e.g. `http://localhost:3000/api/3`** > - **e.g. `http://localhost:3000/api/3`**
* **`/api/list`** #### `/api/list`
> return a list of all images on the server (explicitly from the `/images` directory) > return a list of all images on the server (explicitly from the `/images` directory)
> - e.g. `http://localhost:3000/api/list` > - e.g. `http://localhost:3000/api/list`
* **`/api/random`**
#### `/api/random`
> returns data about a random image on the server > returns data about a random image on the server
> - e.g `http://localhost:3000/api/random` > - e.g `http://localhost:3000/api/random`
## License ## License
**catApi** is licensed under the [MIT](https://github.com/NotAShelf/catApi/blob/v1/LICENSE) license. > **catApi** is licensed under the [MIT](https://github.com/NotAShelf/catApi/blob/v1/LICENSE) license.