95 lines
8.7 KiB
Markdown
95 lines
8.7 KiB
Markdown
|
# Rust API client for openapi
|
||
|
|
|
||
|
|
|
||
|
|
[](https://github.com/FurryCoders/furaffinity-api)
|
||
|
|
[](https://github.com/FurryCoders/furaffinity-api/actions/workflows/test.yml)
|
||
|
|
[](https://pypi.org/project/faapi/3.11.6)
|
||
|
|
|
||
|
|
[](/robots.json)
|
||
|
|
[](/docs)
|
||
|
|
[](/redoc)
|
||
|
|
|
||
|
|
Use the Fur Affinity API badge for your projects! [](https://furaffinity-api.herokuapp.com/badge/svg)
|
||
|
|
|
||
|
|
_The badge is provided via [Shields.io](https://shields.io/)._
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
## Overview
|
||
|
|
|
||
|
|
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [openapi-spec](https://openapis.org) from a remote server, you can easily generate an API client.
|
||
|
|
|
||
|
|
- API version: 1.5.5
|
||
|
|
- Package version: 1.5.5
|
||
|
|
- Generator version: 7.11.0
|
||
|
|
- Build package: `org.openapitools.codegen.languages.RustClientCodegen`
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
Put the package under your project folder in a directory named `openapi` and add the following to `Cargo.toml` under `[dependencies]`:
|
||
|
|
|
||
|
|
```
|
||
|
|
openapi = { path = "./openapi" }
|
||
|
|
```
|
||
|
|
|
||
|
|
## Documentation for API Endpoints
|
||
|
|
|
||
|
|
All URIs are relative to *https://furaffinity-api.herokuapp.com*
|
||
|
|
|
||
|
|
Class | Method | HTTP request | Description
|
||
|
|
------------ | ------------- | ------------- | -------------
|
||
|
|
*JournalsApi* | [**get_journal_journal_journal_id_post**](docs/JournalsApi.md#get_journal_journal_journal_id_post) | **POST** /journal/{journal_id}/ | Get Journal
|
||
|
|
*JournalsApi* | [**get_journals_user_username_journals_page_post**](docs/JournalsApi.md#get_journals_user_username_journals_page_post) | **POST** /user/{username}/journals/{page}/ | Get Journals
|
||
|
|
*SubmissionsApi* | [**get_favorites_user_username_favorites_page_post**](docs/SubmissionsApi.md#get_favorites_user_username_favorites_page_post) | **POST** /user/{username}/favorites/{page} | Get Favorites
|
||
|
|
*SubmissionsApi* | [**get_frontpage_frontpage_post**](docs/SubmissionsApi.md#get_frontpage_frontpage_post) | **POST** /frontpage/ | Get Frontpage
|
||
|
|
*SubmissionsApi* | [**get_gallery_user_username_gallery_page_post**](docs/SubmissionsApi.md#get_gallery_user_username_gallery_page_post) | **POST** /user/{username}/gallery/{page}/ | Get Gallery
|
||
|
|
*SubmissionsApi* | [**get_scraps_user_username_scraps_page_post**](docs/SubmissionsApi.md#get_scraps_user_username_scraps_page_post) | **POST** /user/{username}/scraps/{page}/ | Get Scraps
|
||
|
|
*SubmissionsApi* | [**get_submission_file_submission_submission_id_file_post**](docs/SubmissionsApi.md#get_submission_file_submission_submission_id_file_post) | **POST** /submission/{submission_id}/file/ | Get Submission File
|
||
|
|
*SubmissionsApi* | [**get_submission_submission_submission_id_post**](docs/SubmissionsApi.md#get_submission_submission_submission_id_post) | **POST** /submission/{submission_id}/ | Get Submission
|
||
|
|
*UserApi* | [**get_favorites_user_username_favorites_page_post**](docs/UserApi.md#get_favorites_user_username_favorites_page_post) | **POST** /user/{username}/favorites/{page} | Get Favorites
|
||
|
|
*UserApi* | [**get_gallery_user_username_gallery_page_post**](docs/UserApi.md#get_gallery_user_username_gallery_page_post) | **POST** /user/{username}/gallery/{page}/ | Get Gallery
|
||
|
|
*UserApi* | [**get_journals_user_username_journals_page_post**](docs/UserApi.md#get_journals_user_username_journals_page_post) | **POST** /user/{username}/journals/{page}/ | Get Journals
|
||
|
|
*UserApi* | [**get_login_user_me_post**](docs/UserApi.md#get_login_user_me_post) | **POST** /me/ | Get Login User
|
||
|
|
*UserApi* | [**get_scraps_user_username_scraps_page_post**](docs/UserApi.md#get_scraps_user_username_scraps_page_post) | **POST** /user/{username}/scraps/{page}/ | Get Scraps
|
||
|
|
*UserApi* | [**get_user_user_username_post**](docs/UserApi.md#get_user_user_username_post) | **POST** /user/{username}/ | Get User
|
||
|
|
*UserApi* | [**get_user_watchlist_by_user_username_watchlist_by_page_post**](docs/UserApi.md#get_user_watchlist_by_user_username_watchlist_by_page_post) | **POST** /user/{username}/watchlist/by/{page}/ | Get User Watchlist By
|
||
|
|
*UserApi* | [**get_user_watchlist_to_user_username_watchlist_to_page_post**](docs/UserApi.md#get_user_watchlist_to_user_username_watchlist_to_page_post) | **POST** /user/{username}/watchlist/to/{page}/ | Get User Watchlist To
|
||
|
|
|
||
|
|
|
||
|
|
## Documentation For Models
|
||
|
|
|
||
|
|
- [Body](docs/Body.md)
|
||
|
|
- [Comment](docs/Comment.md)
|
||
|
|
- [Cookie](docs/Cookie.md)
|
||
|
|
- [Detail](docs/Detail.md)
|
||
|
|
- [Error](docs/Error.md)
|
||
|
|
- [HttpValidationError](docs/HttpValidationError.md)
|
||
|
|
- [Journal](docs/Journal.md)
|
||
|
|
- [JournalPartial](docs/JournalPartial.md)
|
||
|
|
- [JournalStats](docs/JournalStats.md)
|
||
|
|
- [JournalsFolder](docs/JournalsFolder.md)
|
||
|
|
- [Next](docs/Next.md)
|
||
|
|
- [Submission](docs/Submission.md)
|
||
|
|
- [SubmissionPartial](docs/SubmissionPartial.md)
|
||
|
|
- [SubmissionStats](docs/SubmissionStats.md)
|
||
|
|
- [SubmissionUserFolder](docs/SubmissionUserFolder.md)
|
||
|
|
- [SubmissionsFolder](docs/SubmissionsFolder.md)
|
||
|
|
- [User](docs/User.md)
|
||
|
|
- [UserPartial](docs/UserPartial.md)
|
||
|
|
- [UserStats](docs/UserStats.md)
|
||
|
|
- [ValidationError](docs/ValidationError.md)
|
||
|
|
- [ValidationErrorLocInner](docs/ValidationErrorLocInner.md)
|
||
|
|
- [Watchlist](docs/Watchlist.md)
|
||
|
|
|
||
|
|
|
||
|
|
To get access to the crate's generated documentation, use:
|
||
|
|
|
||
|
|
```
|
||
|
|
cargo doc --open
|
||
|
|
```
|
||
|
|
|
||
|
|
## Author
|
||
|
|
|
||
|
|
|
||
|
|
|