modulepackage
0.0.0-20220405223321-04789f6bde6d
Repository: https://github.com/bob620/mangodex.git
Documentation: pkg.go.dev
# README
mangodex
Golang API wrapper for MangaDex v5's MVP API.
Full API documentation is found here.
This branch contains only essential services, such as Manga searching and image downloading.
Installation
To install, do go get -u github.com/darylhjd/mangodex@essential
.
Usage
package main
import (
"fmt"
m "github.com/darylhjd/mangodex@simple"
)
func main() {
// Create new client.
// Without logging in, you may not be able to access
// all API functionality.
c := m.NewDexClient()
// Login using your username and password.
err := c.Auth.Login("user", "password")
if err != nil {
fmt.Println("Could not login!")
}
}
Contributing
Any contributions are welcome.
# Functions
NewDexClient : New anonymous client.
# Constants
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
MangaRelationAdaptedFrom : The original work this spin-off manga has been adapted from.
MangaRelationAlternateStory : An alternative take of the story in this manga.
MangaRelationAlternateVersion : A different version of this manga with no other specific distinction.
MangaRelationBasedOn : The original work this self-published derivative manga is based on.
MangaRelationColored : A Colored variant of this manga.
MangaRelationDoujinshi : A self-published derivative work based on this manga.
MangaRelationMainStory : The original narrative this manga is based on.
MangaRelationMonochrome : A Monochrome variant of this manga.
MangaRelationPrequel : The previous entry in the same series.
MangaRelationPreserialization : The original version of this manga before its official serialization.
MangaRelationSameFranchise : A manga based on the same intellectual property as this manga.
MangaRelationSequel : The next entry in the same series.
MangaRelationSerialization : The official serialization of this manga.
MangaRelationSharedUniverse A manga taking place in the same fictional world as this manga.
MangaRelationSideStory : A side work contemporaneous with the narrative of this manga.
MangaRelationSpinOff : An official derivative work based on this manga.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Structs
AuthorAttributes : Attributes for an Author.
Chapter : Struct containing information on a manga.
ChapterAttributes : Attributes for a Chapter.
ChaptersData : Struct containing data for the chapter's pages.
DexClient : The MangaDex client.
No description provided by the author
Error : Struct containing details of an error.
ErrorResponse : Typical response for errored requests.
No description provided by the author
LocalisedStrings : A struct wrapping around a map containing each localised string.
Manga : Struct containing information on a Manga.
MangaAttributes : Attributes for a Manga.
MDHomeClient : Client for interfacing with MangaDex@Home.
MDHomeServerResponse : A response for getting a server URL to get chapters.
Relationship : Struct containing relationships, with optional attributes for the relation.
No description provided by the author
ScanlationGroupAttributes : Attributes for a scanlation group.
No description provided by the author
Tag : Struct containing information on a tag.
TagAttributes : Attributes for a Tag.
# Type aliases
AtHomeService : Provides MangaDex@Home services provided by the API.
AuthService : Provides Auth services provided by the API.
ChapterService : Provides Chapter services provided by the API.
No description provided by the author
No description provided by the author
No description provided by the author
MangaService : Provides Manga services provided by the API.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
UserService : Provides User services provided by the API.