komga_api_client 41.1.0

Dart native
Flutter Android iOS

Generated dart package for interacting with the Komga API in Dart with Dio. NB This package is generated automatically using Open API codegen.

Komga API Client #

Komga offers 2 APIs: REST and OPDS.

Both APIs are secured using HTTP Basic Authentication.

This Dart package is automatically generated by the OpenAPI Generator project:

  • API version: v37.0
  • Build package: org.openapitools.codegen.languages.DartDioClientCodegen

Requirements #

Dart 1.20.0 or later OR Flutter 0.0.20 or later

Installation & Usage #

Github #

If this Dart package is published to Github, please include the following in pubspec.yaml

name: Komga API Client
version: 37
description: Generated dart package for interacting with Komga's API in Dart with Dio
dependencies:
  Komga API Client:
    git: https://github.com/frameset/komga_api_client.git
      version: 'any'

Local #

To use the package in your local drive, please include the following in pubspec.yaml

dependencies:
  Komga API Client:
    path: /path/to/Komga API Client

Getting Started #

Please follow the installation procedure and then run the following:

import 'package:Komga API Client/api.dart';


var api_instance = new BookControllerApi();
var bookId = 789; // int | 

try {
    api_instance.analyze(bookId);
} catch (e) {
    print("Exception when calling BookControllerApi->analyze: $e\n");
}

Documentation for API Endpoints #

All URIs are relative to https://demo.komga.org

ClassMethodHTTP requestDescription
BookControllerApianalyzepost /api/v1/books/{bookId}/analyze
BookControllerApideleteReadProgressdelete /api/v1/books/{bookId}/read-progress
BookControllerApigetAllBooksget /api/v1/books
BookControllerApigetBookFileget /api/v1/books/{bookId}/file
BookControllerApigetBookFile1get /api/v1/books/{bookId}/file/*
BookControllerApigetBookPageget /api/v1/books/{bookId}/pages/{pageNumber}
BookControllerApigetBookPageThumbnailget /api/v1/books/{bookId}/pages/{pageNumber}/thumbnail
BookControllerApigetBookPagesget /api/v1/books/{bookId}/pages
BookControllerApigetBookSiblingNextget /api/v1/books/{bookId}/next
BookControllerApigetBookSiblingPreviousget /api/v1/books/{bookId}/previous
BookControllerApigetBookThumbnailget /api/v1/books/{bookId}/thumbnail
BookControllerApigetBooksOnDeckget /api/v1/books/ondeck
BookControllerApigetLatestBooksget /api/v1/books/latest
BookControllerApigetOneBookget /api/v1/books/{bookId}
BookControllerApimarkReadProgresspatch /api/v1/books/{bookId}/read-progress
BookControllerApirefreshMetadatapost /api/v1/books/{bookId}/metadata/refresh
BookControllerApiupdateMetadatapatch /api/v1/books/{bookId}/metadata
ClaimControllerApiclaimAdminpost /api/v1/claim
FileSystemControllerApigetDirectoryListingpost /api/v1/filesystem
LibraryControllerApiaddOnepost /api/v1/libraries
LibraryControllerApianalyze1post /api/v1/libraries/{libraryId}/analyze
LibraryControllerApideleteOnedelete /api/v1/libraries/{id}
LibraryControllerApigetAllget /api/v1/libraries
LibraryControllerApigetOneget /api/v1/libraries/{id}
LibraryControllerApirefreshMetadata1post /api/v1/libraries/{libraryId}/metadata/refresh
LibraryControllerApiscanpost /api/v1/libraries/{libraryId}/scan
ReferentialControllerApigetAuthorsget /api/v1/authors
SeriesControllerApianalyze2post /api/v1/series/{seriesId}/analyze
SeriesControllerApigetAllBooksBySeriesget /api/v1/series/{seriesId}/books
SeriesControllerApigetAllSeriesget /api/v1/series
SeriesControllerApigetLatestSeriesget /api/v1/series/latest
SeriesControllerApigetNewSeriesget /api/v1/series/new
SeriesControllerApigetOneSeriesget /api/v1/series/{seriesId}
SeriesControllerApigetSeriesThumbnailget /api/v1/series/{seriesId}/thumbnail
SeriesControllerApigetUpdatedSeriesget /api/v1/series/updated
SeriesControllerApimarkAsReadpost /api/v1/series/{seriesId}/read-progress
SeriesControllerApimarkAsUnreaddelete /api/v1/series/{seriesId}/read-progress
SeriesControllerApirefreshMetadata2post /api/v1/series/{seriesId}/metadata/refresh
SeriesControllerApiupdateMetadata1patch /api/v1/series/{seriesId}/metadata
UserControllerApiaddOne1post /api/v1/users
UserControllerApideletedelete /api/v1/users/{id}
UserControllerApigetAll1get /api/v1/users
UserControllerApigetMeget /api/v1/users/me
UserControllerApiupdatePasswordpatch /api/v1/users/me/password
UserControllerApiupdateSharesLibrariespatch /api/v1/users/{id}/shared-libraries
UserControllerApiupdateUserRolespatch /api/v1/users/{id}

Documentation For Models #

Documentation For Authorization #

basicAuth #

  • Type: HTTP basic authentication

Author #

1
likes
70
pub points
8%
popularity

Generated dart package for interacting with the Komga API in Dart with Dio. NB This package is generated automatically using Open API codegen.

Repository (GitHub)
View/report issues

Documentation

API reference

Uploader

mwinckle@gmail.com

License

MIT (LICENSE)

Dependencies

built_collection, built_value, dio, time_machine

More

Packages that depend on komga_api_client