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

Documentation For Models

• AuthorDto
• AuthorUpdateDto
• BookDto
• BookMetadataDto
• BookMetadataUpdateDto
• DirectoryListingDto
• DirectoryRequestDto
• LibraryCreationDto
• LibraryDto
• MediaDto
• PageBookDto
• PageDto
• PageSeriesDto
• Pageable
• PasswordUpdateDto
• PathDto
• ReadProgressDto
• ReadProgressUpdateDto
• RolesUpdateDto
• SeriesDto
• SeriesMetadataDto
• SeriesMetadataUpdateDto
• SharedLibrariesUpdateDto
• SharedLibraryDto
• Sort
• UserCreationDto
• UserDto
• UserWithSharedLibrariesDto

Documentation For Authorization

basicAuth

• Type: HTTP basic authentication

Author