1个稳定版本
| 1.9.2 | 2024年1月14日 |
|---|
#238 in HTTP客户端
495KB
8K SLoC
Rust API客户端用于OpenAPI
描述
Komga 是一个免费的开源漫画/轻小说服务器。它允许您托管自己的库，并在您喜欢的设备上阅读您的漫画。这些Rust客户端绑定已从OpenAPI规范生成，仅进行了一些小的修改以便编译。
此API客户端由 OpenAPI Generator 项目生成。通过使用来自远程服务器的 openapi-spec，您可以轻松生成API客户端。
概述
Komga提供2个API：REST和OPDS。
这两个API都使用HTTP基本认证进行安全保护。
- API版本：v1.0
- 包版本：v1.0
- 构建包：
org.openapitools.codegen.languages.RustClientCodegen
API端点文档
所有URI均相对于 https://127.0.0.1:25600
| 类 | 方法 | HTTP请求 | 描述 |
|---|---|---|---|
| AnnouncementControllerApi | get_announcements | GET /api/v1/announcements | |
| AnnouncementControllerApi | mark_announcements_read | PUT /api/v1/announcements | |
| BookControllerApi | add_user_uploaded_book_thumbnail | POST /api/v1/books/{bookId}/thumbnails | |
| BookControllerApi | analyze3 | POST /api/v1/books/{bookId}/analyze | |
| BookControllerApi | delete_book | DELETE /api/v1/books/{bookId}/file | |
| BookControllerApi | delete_read_progress | DELETE /api/v1/books/{bookId}/read-progress | |
| BookControllerApi | delete_user_uploaded_book_thumbnail | DELETE /api/v1/books/{bookId}/thumbnails/{thumbnailId} | |
| BookControllerApi | get_all_books | GET /api/v1/books | |
| BookControllerApi | get_all_read_lists_by_book | GET /api/v1/books/{bookId}/readlists | |
| BookControllerApi | get_book_file | GET /api/v1/books/{bookId}/file | |
| BookControllerApi | get_book_file1 | GET /api/v1/books/{bookId}/file/* | |
| BookControllerApi | get_book_page | GET /api/v1/books/{bookId}/pages/{pageNumber} | |
| BookControllerApi | get_book_page_raw | GET /api/v1/books/{bookId}/pages/{pageNumber}/raw | |
| BookControllerApi | get_book_page_thumbnail | GET /api/v1/books/{bookId}/pages/{pageNumber}/thumbnail | |
| BookControllerApi | get_book_pages | GET /api/v1/books/{bookId}/pages | |
| BookControllerApi | get_book_resource | GET /api/v1/books/{bookId}/resource/{resource} | |
| BookControllerApi | 获取图书兄弟节点下一条 | GET /api/v1/books/{bookId}/next | |
| BookControllerApi | 获取图书兄弟节点上一条 | GET /api/v1/books/{bookId}/previous | |
| BookControllerApi | 获取图书缩略图 | GET /api/v1/books/{bookId}/thumbnail | |
| BookControllerApi | 通过ID获取图书缩略图 | GET /api/v1/books/{bookId}/thumbnails/{thumbnailId} | |
| BookControllerApi | 获取图书缩略图列表 | GET /api/v1/books/{bookId}/thumbnails | |
| BookControllerApi | 获取书架上的图书 | GET /api/v1/books/ondeck | |
| BookControllerApi | 获取重复图书 | GET /api/v1/books/duplicates | |
| BookControllerApi | 获取最新图书 | GET /api/v1/books/latest | |
| BookControllerApi | 获取单个图书 | GET /api/v1/books/{bookId} | |
| BookControllerApi | 获取位置 | GET /api/v1/books/{bookId}/positions | |
| BookControllerApi | 获取进度 | GET /api/v1/books/{bookId}/progression | |
| BookControllerApi | 获取网络发布清单 | GET /api/v1/books/{bookId}/manifest | |
| BookControllerApi | 获取网络发布清单（Divina格式） | GET /api/v1/books/{bookId}/manifest/divina | |
| BookControllerApi | 获取网络发布清单（EPUB格式） | GET /api/v1/books/{bookId}/manifest/epub | |
| BookControllerApi | 获取网络发布清单（PDF格式） | GET /api/v1/books/{bookId}/manifest/pdf | |
| BookControllerApi | 导入图书 | POST /api/v1/books/import | |
| BookControllerApi | 标记进度 | PUT /api/v1/books/{bookId}/progression | |
| BookControllerApi | 标记阅读进度 | PATCH /api/v1/books/{bookId}/read-progress | |
| BookControllerApi | 标记选定的图书缩略图 | PUT /api/v1/books/{bookId}/thumbnails/{thumbnailId}/selected | |
| BookControllerApi | 刷新元数据2 | POST /api/v1/books/{bookId}/metadata/refresh | |
| BookControllerApi | 重新生成缩略图 | PUT /api/v1/books/thumbnails | |
| BookControllerApi | 批量更新元数据 | PATCH /api/v1/books/metadata | |
| BookControllerApi | 更新元数据1 | PATCH /api/v1/books/{bookId}/metadata | |
| ClaimControllerApi | 声明管理员 | POST /api/v1/claim | |
| ClaimControllerApi | 获取声明状态 | GET /api/v1/claim | |
| FileSystemControllerApi | 获取目录列表 | POST /api/v1/filesystem | |
| HistoricalEventControllerApi | 获取所有3 | GET /api/v1/history | |
| LibraryControllerApi | 添加一个2 | POST /api/v1/libraries | |
| LibraryControllerApi | 分析2 | POST /api/v1/libraries/{libraryId}/analyze | |
| LibraryControllerApi | 删除一个1 | DELETE /api/v1/libraries/{libraryId} | |
| LibraryControllerApi | 清空回收站 | POST /api/v1/libraries/{libraryId}/empty-trash | |
| LibraryControllerApi | 获取所有2 | GET /api/v1/libraries | |
| LibraryControllerApi | 获取一个1 | GET /api/v1/libraries/{libraryId} | |
| LibraryControllerApi | 部分更新一个 | PATCH /api/v1/libraries/{libraryId} | |
| LibraryControllerApi | 刷新元数据1 | POST /api/v1/libraries/{libraryId}/metadata/refresh | |
| LibraryControllerApi | 扫描 | POST /api/v1/libraries/{libraryId}/scan | |
| LibraryControllerApi | 更新一个 | PUT /api/v1/libraries/{libraryId} | |
| LoginControllerApi | 将头部转换为cookie | GET /api/v1/login/set-cookie | |
| OAuth2ControllerApi | 获取提供商 | GET /api/v1/oauth2/providers | |
| OAuth2ControllerApi | 获取提供商1 | HEAD /api/v1/oauth2/providers | |
| OAuth2ControllerApi | 获取提供商2 | POST /api/v1/oauth2/providers | |
| OAuth2ControllerApi | 获取提供商3 | PUT /api/v1/oauth2/providers | |
| OAuth2ControllerApi | 获取提供商4 | PATCH /api/v1/oauth2/providers | |
| OAuth2ControllerApi | 获取提供商5 | DELETE /api/v1/oauth2/providers | |
| OAuth2ControllerApi | 获取提供商6 | OPTIONS /api/v1/oauth2/providers | |
| PageHashControllerApi | 创建或更新已知的页面哈希 | PUT /api/v1/page-hashes | |
| PageHashControllerApi | 删除单个匹配 | POST /api/v1/page-hashes/{pageHash}/delete-match | |
| PageHashControllerApi | 获取已知页面哈希缩略图 | GET /api/v1/page-hashes/{pageHash}/thumbnail | |
| PageHashControllerApi | 获取已知页面哈希 | GET /api/v1/page-hashes | |
| PageHashControllerApi | 获取页面哈希匹配 | GET /api/v1/page-hashes/{pageHash} | |
| PageHashControllerApi | 获取未知页面哈希缩略图 | GET /api/v1/page-hashes/unknown/{pageHash}/thumbnail | |
| PageHashControllerApi | 获取未知页面哈希 | GET /api/v1/page-hashes/unknown | |
| PageHashControllerApi | 执行删除 | POST /api/v1/page-hashes/{pageHash}/delete-all | |
| ReadListControllerApi | 添加一个1 | POST /api/v1/readlists | |
| ReadListControllerApi | 添加用户上传的阅读列表缩略图 | POST /api/v1/readlists/{id}/thumbnails | |
| ReadListControllerApi | 删除一个 | DELETE /api/v1/readlists/{id} | |
| ReadListControllerApi | 删除用户上传的阅读列表缩略图 | DELETE /api/v1/readlists/{id}/thumbnails/{thumbnailId} | |
| ReadListControllerApi | 获取所有1 | GET /api/v1/readlists | |
| ReadListControllerApi | 获取阅读列表兄弟节点下一条 | GET /api/v1/readlists/{id}/books/{bookId}/next | |
| ReadListControllerApi | 获取阅读列表兄弟节点上一条 | GET /api/v1/readlists/{id}/books/{bookId}/previous | |
| ReadListControllerApi | 获取阅读列表的图书 | GET /api/v1/readlists/{id}/books | |
| ReadListControllerApi | 获取一个 | GET /api/v1/readlists/{id} | |
| ReadListControllerApi | 获取阅读列表文件 | GET /api/v1/readlists/{id}/file | |
| ReadListControllerApi | get_read_list_thumbnail | GET /api/v1/readlists/{id}/thumbnail | |
| ReadListControllerApi | get_read_list_thumbnail_by_id | GET /api/v1/readlists/{id}/thumbnails/{thumbnailId} | |
| ReadListControllerApi | get_read_list_thumbnails | GET /api/v1/readlists/{id}/thumbnails | |
| ReadListControllerApi | get_read_progress | GET /api/v1/readlists/{id}/read-progress/tachiyomi | |
| ReadListControllerApi | mark_read_progress_tachiyomi | PUT /api/v1/readlists/{id}/read-progress/tachiyomi | |
| ReadListControllerApi | mark_selected_read_list_thumbnail | PUT /api/v1/readlists/{id}/thumbnails/{thumbnailId}/selected | |
| ReadListControllerApi | match_from_comic_rack_list | POST /api/v1/readlists/match/comicrack | |
| ReadListControllerApi | update_one1 | PATCH /api/v1/readlists/{id} | |
| ReferentialControllerApi | get_age_ratings | GET /api/v1/age-ratings | |
| ReferentialControllerApi | get_authors | GET /api/v2/authors | |
| ReferentialControllerApi | get_authors_names | GET /api/v1/authors/names | |
| ReferentialControllerApi | get_authors_roles | GET /api/v1/authors/roles | |
| ReferentialControllerApi | get_authors_v1 | GET /api/v1/authors | |
| ReferentialControllerApi | get_book_tags | GET /api/v1/tags/book | |
| ReferentialControllerApi | get_genres | GET /api/v1/genres | |
| ReferentialControllerApi | get_languages | GET /api/v1/languages | |
| ReferentialControllerApi | get_publishers | GET /api/v1/publishers | |
| ReferentialControllerApi | get_series_release_dates | GET /api/v1/series/release-dates | |
| ReferentialControllerApi | get_series_tags | GET /api/v1/tags/series | |
| ReferentialControllerApi | get_sharing_labels | GET /api/v1/sharing-labels | |
| ReferentialControllerApi | get_tags | GET /api/v1/tags | |
| SeriesCollectionControllerApi | add_one3 | POST /api/v1/collections | |
| SeriesCollectionControllerApi | add_user_uploaded_collection_thumbnail | POST /api/v1/collections/{id}/thumbnails | |
| SeriesCollectionControllerApi | delete_one2 | DELETE /api/v1/collections/{id} | |
| SeriesCollectionControllerApi | delete_user_uploaded_collection_thumbnail | DELETE /api/v1/collections/{id}/thumbnails/{thumbnailId} | |
| SeriesCollectionControllerApi | get_all4 | GET /api/v1/collections | |
| SeriesCollectionControllerApi | get_collection_thumbnail | GET /api/v1/collections/{id}/thumbnail | |
| SeriesCollectionControllerApi | get_collection_thumbnail_by_id | GET /api/v1/collections/{id}/thumbnails/{thumbnailId} | |
| SeriesCollectionControllerApi | get_collection_thumbnails | GET /api/v1/collections/{id}/thumbnails | |
| SeriesCollectionControllerApi | get_one2 | GET /api/v1/collections/{id} | |
| SeriesCollectionControllerApi | get_series_for_collection | GET /api/v1/collections/{id}/series | |
| SeriesCollectionControllerApi | mark_selected_collection_thumbnail | PUT /api/v1/collections/{id}/thumbnails/{thumbnailId}/selected | |
| SeriesCollectionControllerApi | update_one2 | PATCH /api/v1/collections/{id} | |
| SeriesControllerApi | analyze1 | POST /api/v1/series/{seriesId}/analyze | |
| SeriesControllerApi | delete_series | DELETE /api/v1/series/{seriesId}/file | |
| SeriesControllerApi | delete_user_uploaded_series_thumbnail | DELETE /api/v1/series/{seriesId}/thumbnails/{thumbnailId} | |
| SeriesControllerApi | get_all_books_by_series | GET /api/v1/series/{seriesId}/books | |
| SeriesControllerApi | get_all_collections_by_series | GET /api/v1/series/{seriesId}/collections | |
| SeriesControllerApi | get_all_series | GET /api/v1/series | |
| SeriesControllerApi | get_alphabetical_groups | GET /api/v1/series/alphabetical-groups | |
| SeriesControllerApi | get_latest_series | GET /api/v1/series/latest | |
| SeriesControllerApi | get_new_series | GET /api/v1/series/new | |
| SeriesControllerApi | get_one_series | GET /api/v1/series/{seriesId} | |
| SeriesControllerApi | get_read_progress_tachiyomi_v2 | GET /api/v2/series/{seriesId}/read-progress/tachiyomi | |
| SeriesControllerApi | get_series_default_thumbnail | GET /api/v1/series/{seriesId}/thumbnail | |
| SeriesControllerApi | get_series_file | GET /api/v1/series/{seriesId}/file | |
| SeriesControllerApi | get_series_thumbnail_by_id | GET /api/v1/series/{seriesId}/thumbnails/{thumbnailId} | |
| SeriesControllerApi | get_series_thumbnails | GET /api/v1/series/{seriesId}/thumbnails | |
| SeriesControllerApi | get_updated_series | GET /api/v1/series/updated | |
| SeriesControllerApi | mark_as_read | POST /api/v1/series/{seriesId}/read-progress | |
| SeriesControllerApi | mark_as_unread | DELETE /api/v1/series/{seriesId}/read-progress | |
| SeriesControllerApi | mark_read_progress_tachiyomi_v2 | PUT /api/v2/series/{seriesId}/read-progress/tachiyomi | |
| SeriesControllerApi | post_mark_selected_series_thumbnail | PUT /api/v1/series/{seriesId}/thumbnails/{thumbnailId}/selected | |
| SeriesControllerApi | post_user_uploaded_series_thumbnail | POST /api/v1/series/{seriesId}/thumbnails | |
| SeriesControllerApi | refresh_metadata | POST /api/v1/series/{seriesId}/metadata/refresh | |
| SeriesControllerApi | update_metadata | PATCH /api/v1/series/{seriesId}/metadata | |
| SettingsControllerApi | get_settings | GET /api/v1/settings | |
| SettingsControllerApi | update_settings | PATCH /api/v1/settings | |
| TaskControllerApi | empty_task_queue | DELETE /api/v1/tasks | |
| TransientBooksControllerApi | analyze | POST /api/v1/transient-books/{id}/analyze | |
| TransientBooksControllerApi | get_source_page | GET /api/v1/transient-books/{id}/pages/{pageNumber} | |
| TransientBooksControllerApi | 扫描临时书籍 | POST /api/v1/transient-books | |
| 用户控制器API | 添加一个 | POST /api/v2/users | |
| 用户控制器API | 删除 | DELETE /api/v2/users/{id} | |
| 用户控制器API | 获取全部 | GET /api/v2/users | |
| 用户控制器API | 获取认证活动 | GET /api/v2/users/authentication-activity | |
| 用户控制器API | 获取用户的最新认证活动 | GET /api/v2/users/{id}/authentication-activity/latest | |
| 用户控制器API | 获取我 | GET /api/v2/users/me | |
| 用户控制器API | 获取我的认证活动 | GET /api/v2/users/me/authentication-activity | |
| 用户控制器API | 更新我的密码 | PATCH /api/v2/users/me/password | |
| 用户控制器API | 更新密码 | PATCH /api/v2/users/{id}/password | |
| 用户控制器API | 更新用户 | PATCH /api/v2/users/{id} |
模型文档
- AgeRestrictionDto
- AgeRestrictionUpdateDto
- AlternateTitleDto
- AlternateTitleUpdateDto
- AuthenticationActivityDto
- AuthorDto
- AuthorUpdateDto
- BookDto
- BookImportBatchDto
- BookImportDto
- BookMetadataAggregationDto
- BookMetadataDto
- BookMetadataUpdateDto
- ClaimStatus
- CollectionCreationDto
- CollectionDto
- CollectionUpdateDto
- DirectoryListingDto
- DirectoryRequestDto
- GroupCountDto
- HistoricalEventDto
- ItemDto
- JsonFeedDto
- KomgaExtensionDto
- LibraryCreationDto
- LibraryDto
- LibraryUpdateDto
- Location
- MediaDto
- MediaType
- OAuth2ClientDto
- PageAuthenticationActivityDto
- PageAuthorDto
- PageBookDto
- PageCollectionDto
- PageDto
- PageHashCreationDto
- PageHashKnownDto
- PageHashMatchDto
- PageHashUnknownDto
- PageHistoricalEventDto
- PagePageHashKnownDto
- PagePageHashMatchDto
- PagePageHashUnknownDto
- PageReadListDto
- PageSeriesDto
- PageableObject
- PasswordUpdateDto
- PathDto
- PostUserUploadedSeriesThumbnailRequest
- R2Device
- R2Locator
- R2Positions
- R2Progression
- 读列表创建Dto
- ReadListDto
- ReadListMatchDto
- ReadListRequestBookDto
- ReadListRequestBookMatchBookDto
- ReadListRequestBookMatchDto
- ReadListRequestBookMatchSeriesDto
- ReadListRequestBookMatchesDto
- ReadListRequestMatchDto
- ReadListUpdateDto
- ReadProgressDto
- ReadProgressUpdateDto
- 扫描请求Dto
- SeriesDto
- SeriesMetadataDto
- SeriesMetadataUpdateDto
- SettingMultiSourceInteger
- SettingMultiSourceString
- SettingsDto
- SettingsUpdateDto
- SharedLibrariesUpdateDto
- SortObject
- TachiyomiReadProgressDto
- TachiyomiReadProgressUpdateDto
- TachiyomiReadProgressUpdateV2Dto
- TachiyomiReadProgressV2Dto
- Text
- ThumbnailBookDto
- ThumbnailReadListDto
- ThumbnailSeriesCollectionDto
- ThumbnailSeriesDto
- TransientBookDto
- UserCreationDto
- UserDto
- UserUpdateDto
- ValidationErrorResponse
- Violation
- WebLinkDto
- WebLinkUpdateDto
- WpBelongsToDto
- WpContributorDto
- WpLinkDto
- WpMetadataDto
- WpPublicationDto
要获取crate生成的文档，请使用
cargo doc --open
作者
Aaron Spiegel @spiegela
依赖
~4–19MB
~242K SLoC