aboutsummaryrefslogtreecommitdiff
path: root/src/index.rst
blob: 4b9ebe9b8d015953b31940b1c1a75d95c8d36ebb (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
api.senpy.club
==============

This API is on commit {}.

Routes
------

If a language requires a parameter, it will be notated like ":this".

For example; if a route is notated as "/v2/route/:parameter", you can access that route via the URL "https://api.senpy.club/v2/route/parameter-value".

- /
    - /: Index page, a mirror of /v2 (you are here)

- /v2
    - /github: GitHub API mirror for the https://github.com/cat-milk/Anime-Girls-Holding-Programming-Books repository
    - /languages: A list of all languages that appear in the https://github.com/cat-milk/Anime-Girls-Holding-Programming-Books repository
    - /language/:language: A list of all images that are labeled under the language, ":language", in the https://github.com/cat-milk/Anime-Girls-Holding-Programming-Books repository
    - /random: A random image from the https://github.com/cat-milk/Anime-Girls-Holding-Programming-Books repository
    - /me: For future implementation. At the moment; only contains the caller's IP.

- /v2/boys
    - /github: GitHub API mirror for the https://github.com/flyingcakes85/Anime-Boys-Holding-Programming-Books repository
    - /languages: A list of all languages that appear in the https://github.com/flyingcakes85/Anime-Boys-Holding-Programming-Books repository
    - /language/:language: A list of all images that are labeled under the language, ":language", in the https://github.com/flyingcakes85/Anime-Boys-Holding-Programming-Books repository
    - /random: A random image from the https://github.com/flyingcakes85/Anime-Boys-Holding-Programming-Books repository

Notes
-----

Contributing
^^^^^^^^^^^^

If you'd like to support the project in any way, check out the repository: https://github.com/senpy-club/api-worker

Supporting
^^^^^^^^^^

If you would like to support my development ventures, visit my GitHub profile: https://github.com/Fuwn

License
^^^^^^^

`GNU General Public License v3.0 <https://github.com/senpy-club/api-worker/blob/main/LICENSE>`_