Skip to content

Commit

Permalink
[skip ci] Add API info (#798)
Browse files Browse the repository at this point in the history
  • Loading branch information
brianmakesthings authored Dec 26, 2023
1 parent 621b4c0 commit 3ed84de
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,22 @@ Checkout [This Kanban Board](https://github.com/Suwayomi/Tachidesk/projects/1) t

## How does Tachidesk-Server work?
This project has two components:
1. **Server:** contains the implementation of [tachiyomi's extensions library](https://github.com/tachiyomiorg/extensions-lib) and uses an Android compatibility library to run jar libraries converted from apk extensions. All this concludes to serving a REST API.
1. **Server:** contains the implementation of [tachiyomi's extensions library](https://github.com/tachiyomiorg/extensions-lib) and uses an Android compatibility library to run jar libraries converted from apk extensions. All this concludes to serving a GraphQL API.
2. **WebUI:** A React SPA(`create-react-app`) project that works with the server to do the presentation located at https://github.com/Suwayomi/Tachidesk-WebUI

### API
#### GraphQL
*Only available in the preview at the moment*

The GraphQL API can be queried with a POST request to `/api/graphql`. There is also the GraphiQL IDE accessible by the browser at `/api/graphql` to perform ad-hoc queries and explore the API.

#### REST
> [!WARNING]
>
> Soon to be deprecated
The REST API can be queried at `/api/v1`. An interactive Swagger API explorer is available at `/api/swagger-ui`.

## Why a web app?
This structure is chosen to
- Achieve the maximum multi-platform-ness
Expand Down

0 comments on commit 3ed84de

Please sign in to comment.