Skip to content

Latest commit

 

History

History
428 lines (378 loc) · 29.8 KB

README Original.md

File metadata and controls

428 lines (378 loc) · 29.8 KB
Raw

vocadb-api-client

VocaDbWeb

  • API version: 1.0

  • Build date: 2023-12-26T07:29:58.607748373Z[Etc/UTC]

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

  1. Java 1.8+
  2. Maven/Gradle

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>mikufan.cx</groupId>
  <artifactId>vocadb-api-client</artifactId>
  <version>1.0.0</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

  repositories {
    mavenCentral()     // Needed if the 'vocadb-api-client' jar has been published to maven central.
    mavenLocal()       // Needed if the 'vocadb-api-client' jar has been published to the local maven repo.
  }

  dependencies {
     implementation "mikufan.cx:vocadb-api-client:1.0.0"
  }

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

  • target/vocadb-api-client-1.0.0.jar
  • target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

import mikufan.cx.vocadbapiclient.client.*;
import mikufan.cx.vocadbapiclient.client.auth.*;
import mikufan.cx.vocadbapiclient.model.*;
import mikufan.cx.vocadbapiclient.api.ActivityEntryApi;

public class ActivityEntryApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        ActivityEntryApi apiInstance = new ActivityEntryApi(defaultClient);
        LocalDateTime before = new LocalDateTime(); // LocalDateTime | 
        LocalDateTime since = new LocalDateTime(); // LocalDateTime | 
        Integer userId = 56; // Integer | 
        EntryEditEvent editEvent = EntryEditEvent.fromValue("Created"); // EntryEditEvent | 
        EntryType entryType = EntryType.fromValue("Undefined"); // EntryType | 
        Integer maxResults = 50; // Integer | 
        Boolean getTotalCount = false; // Boolean | 
        ActivityEntryOptionalFields fields = ActivityEntryOptionalFields.fromValue("None"); // ActivityEntryOptionalFields | 
        EntryOptionalFields entryFields = EntryOptionalFields.fromValue("None"); // EntryOptionalFields | 
        ContentLanguagePreference lang = ContentLanguagePreference.fromValue("Default"); // ContentLanguagePreference | 
        ActivityEntrySortRule sortRule = ActivityEntrySortRule.fromValue("CreateDateDescending"); // ActivityEntrySortRule | 
        try {
            ActivityEntryForApiContractPartialFindResult result = apiInstance.apiActivityEntriesGet(before, since, userId, editEvent, entryType, maxResults, getTotalCount, fields, entryFields, lang, sortRule);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActivityEntryApi#apiActivityEntriesGet");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
ActivityEntryApi apiActivityEntriesGet GET /api/activityEntries
AlbumApi apiAlbumsCommentsCommentIdDelete DELETE /api/albums/comments/{commentId}
AlbumApi apiAlbumsCommentsCommentIdPost POST /api/albums/comments/{commentId}
AlbumApi apiAlbumsGet GET /api/albums
AlbumApi apiAlbumsIdCommentsGet GET /api/albums/{id}/comments
AlbumApi apiAlbumsIdCommentsPost POST /api/albums/{id}/comments
AlbumApi apiAlbumsIdDelete DELETE /api/albums/{id}
AlbumApi apiAlbumsIdGet GET /api/albums/{id}
AlbumApi apiAlbumsIdRelatedGet GET /api/albums/{id}/related
AlbumApi apiAlbumsIdReviewsGet GET /api/albums/{id}/reviews
AlbumApi apiAlbumsIdReviewsPost POST /api/albums/{id}/reviews
AlbumApi apiAlbumsIdReviewsReviewIdDelete DELETE /api/albums/{id}/reviews/{reviewId}
AlbumApi apiAlbumsIdTracksFieldsGet GET /api/albums/{id}/tracks/fields
AlbumApi apiAlbumsIdTracksGet GET /api/albums/{id}/tracks
AlbumApi apiAlbumsIdUserCollectionsGet GET /api/albums/{id}/user-collections
AlbumApi apiAlbumsNamesGet GET /api/albums/names
AlbumApi apiAlbumsNewGet GET /api/albums/new
AlbumApi apiAlbumsTopGet GET /api/albums/top
ArtistApi apiArtistsCommentsCommentIdDelete DELETE /api/artists/comments/{commentId}
ArtistApi apiArtistsCommentsCommentIdPost POST /api/artists/comments/{commentId}
ArtistApi apiArtistsGet GET /api/artists
ArtistApi apiArtistsIdCommentsGet GET /api/artists/{id}/comments
ArtistApi apiArtistsIdCommentsPost POST /api/artists/{id}/comments
ArtistApi apiArtistsIdDelete DELETE /api/artists/{id}
ArtistApi apiArtistsIdGet GET /api/artists/{id}
ArtistApi apiArtistsNamesGet GET /api/artists/names
CommentApi apiCommentsEntryTypeCommentsCommentIdDelete DELETE /api/comments/{entryType}-comments/{commentId}
CommentApi apiCommentsEntryTypeCommentsCommentIdPost POST /api/comments/{entryType}-comments/{commentId}
CommentApi apiCommentsEntryTypeCommentsGet GET /api/comments/{entryType}-comments
CommentApi apiCommentsEntryTypeCommentsPost POST /api/comments/{entryType}-comments
CommentApi apiCommentsGet GET /api/comments
DiscussionApi apiDiscussionsCommentsCommentIdDelete DELETE /api/discussions/comments/{commentId}
DiscussionApi apiDiscussionsCommentsCommentIdPost POST /api/discussions/comments/{commentId}
DiscussionApi apiDiscussionsFoldersFolderIdTopicsGet GET /api/discussions/folders/{folderId}/topics
DiscussionApi apiDiscussionsFoldersFolderIdTopicsPost POST /api/discussions/folders/{folderId}/topics
DiscussionApi apiDiscussionsFoldersGet GET /api/discussions/folders
DiscussionApi apiDiscussionsFoldersPost POST /api/discussions/folders
DiscussionApi apiDiscussionsTopicsGet GET /api/discussions/topics
DiscussionApi apiDiscussionsTopicsTopicIdCommentsPost POST /api/discussions/topics/{topicId}/comments
DiscussionApi apiDiscussionsTopicsTopicIdDelete DELETE /api/discussions/topics/{topicId}
DiscussionApi apiDiscussionsTopicsTopicIdGet GET /api/discussions/topics/{topicId}
DiscussionApi apiDiscussionsTopicsTopicIdPost POST /api/discussions/topics/{topicId}
EntryApi apiEntriesGet GET /api/entries
EntryApi apiEntriesNamesGet GET /api/entries/names
EntryTypesApi apiEntryTypesEntryTypeSubTypeTagGet GET /api/entry-types/{entryType}/{subType}/tag
PvApi apiPvsForSongsGet GET /api/pvs/for-songs
PvApi apiPvsThumbnailGet GET /api/pvs/thumbnail
ReleaseEventApi apiReleaseEventsEventIdAlbumsGet GET /api/releaseEvents/{eventId}/albums
ReleaseEventApi apiReleaseEventsEventIdPublishedSongsGet GET /api/releaseEvents/{eventId}/published-songs
ReleaseEventApi apiReleaseEventsEventIdReportsPost POST /api/releaseEvents/{eventId}/reports
ReleaseEventApi apiReleaseEventsGet GET /api/releaseEvents
ReleaseEventApi apiReleaseEventsIdDelete DELETE /api/releaseEvents/{id}
ReleaseEventApi apiReleaseEventsIdGet GET /api/releaseEvents/{id}
ReleaseEventApi apiReleaseEventsNamesGet GET /api/releaseEvents/names
ReleaseEventSeriesApi apiReleaseEventSeriesGet GET /api/releaseEventSeries
ReleaseEventSeriesApi apiReleaseEventSeriesIdDelete DELETE /api/releaseEventSeries/{id}
ReleaseEventSeriesApi apiReleaseEventSeriesIdForEditGet GET /api/releaseEventSeries/{id}/for-edit
ReleaseEventSeriesApi apiReleaseEventSeriesIdGet GET /api/releaseEventSeries/{id}
ResourcesApi apiResourcesCultureCodeGet GET /api/resources/{cultureCode}
SongApi apiSongsByPvGet GET /api/songs/byPv
SongApi apiSongsCommentsCommentIdDelete DELETE /api/songs/comments/{commentId}
SongApi apiSongsCommentsCommentIdPost POST /api/songs/comments/{commentId}
SongApi apiSongsGet GET /api/songs
SongApi apiSongsHighlightedGet GET /api/songs/highlighted
SongApi apiSongsIdCommentsGet GET /api/songs/{id}/comments
SongApi apiSongsIdCommentsPost POST /api/songs/{id}/comments
SongApi apiSongsIdDelete DELETE /api/songs/{id}
SongApi apiSongsIdDerivedGet GET /api/songs/{id}/derived
SongApi apiSongsIdGet GET /api/songs/{id}
SongApi apiSongsIdRatingsGet GET /api/songs/{id}/ratings
SongApi apiSongsIdRatingsPost POST /api/songs/{id}/ratings
SongApi apiSongsIdRelatedGet GET /api/songs/{id}/related
SongApi apiSongsLyricsLyricsIdGet GET /api/songs/lyrics/{lyricsId}
SongApi apiSongsNamesGet GET /api/songs/names
SongApi apiSongsTopRatedGet GET /api/songs/top-rated
SongListApi apiSongListsCommentsCommentIdDelete DELETE /api/songLists/comments/{commentId}
SongListApi apiSongListsCommentsCommentIdPost POST /api/songLists/comments/{commentId}
SongListApi apiSongListsFeaturedGet GET /api/songLists/featured
SongListApi apiSongListsFeaturedNamesGet GET /api/songLists/featured/names
SongListApi apiSongListsIdDelete DELETE /api/songLists/{id}
SongListApi apiSongListsListIdCommentsGet GET /api/songLists/{listId}/comments
SongListApi apiSongListsListIdCommentsPost POST /api/songLists/{listId}/comments
SongListApi apiSongListsListIdSongsGet GET /api/songLists/{listId}/songs
SongListApi apiSongListsPost POST /api/songLists
TagApi apiTagsByNameNameGet GET /api/tags/byName/{name}
TagApi apiTagsCategoryNamesGet GET /api/tags/categoryNames
TagApi apiTagsCommentsCommentIdDelete DELETE /api/tags/comments/{commentId}
TagApi apiTagsCommentsCommentIdPost POST /api/tags/comments/{commentId}
TagApi apiTagsGet GET /api/tags
TagApi apiTagsIdDelete DELETE /api/tags/{id}
TagApi apiTagsIdGet GET /api/tags/{id}
TagApi apiTagsNamesGet GET /api/tags/names
TagApi apiTagsPost POST /api/tags
TagApi apiTagsTagIdChildrenGet GET /api/tags/{tagId}/children
TagApi apiTagsTagIdCommentsGet GET /api/tags/{tagId}/comments
TagApi apiTagsTagIdCommentsPost POST /api/tags/{tagId}/comments
TagApi apiTagsTagIdReportsPost POST /api/tags/{tagId}/reports
TagApi apiTagsTopGet GET /api/tags/top
UserApi apiUsersCurrentAlbumCollectionStatusesAlbumIdGet GET /api/users/current/album-collection-statuses/{albumId}
UserApi apiUsersCurrentAlbumsAlbumIdPost POST /api/users/current/albums/{albumId}
UserApi apiUsersCurrentFollowedArtistsArtistIdGet GET /api/users/current/followedArtists/{artistId}
UserApi apiUsersCurrentFollowedTagsTagIdDelete DELETE /api/users/current/followedTags/{tagId}
UserApi apiUsersCurrentFollowedTagsTagIdPost POST /api/users/current/followedTags/{tagId}
UserApi apiUsersCurrentGet GET /api/users/current
UserApi apiUsersCurrentRatedSongsSongIdGet GET /api/users/current/ratedSongs/{songId}
UserApi apiUsersCurrentRefreshEntryEditPost POST /api/users/current/refreshEntryEdit
UserApi apiUsersCurrentSongTagsSongIdPost POST /api/users/current/songTags/{songId}
UserApi apiUsersGet GET /api/users
UserApi apiUsersIdAlbumCollectionStatusesAlbumIdGet GET /api/users/{id}/album-collection-statuses/{albumId}
UserApi apiUsersIdAlbumsGet GET /api/users/{id}/albums
UserApi apiUsersIdEventsGet GET /api/users/{id}/events
UserApi apiUsersIdFollowedArtistsArtistIdGet GET /api/users/{id}/followedArtists/{artistId}
UserApi apiUsersIdFollowedArtistsGet GET /api/users/{id}/followedArtists
UserApi apiUsersIdGet GET /api/users/{id}
UserApi apiUsersIdMessagesDelete DELETE /api/users/{id}/messages
UserApi apiUsersIdMessagesGet GET /api/users/{id}/messages
UserApi apiUsersIdMessagesPost POST /api/users/{id}/messages
UserApi apiUsersIdProfileCommentsGet GET /api/users/{id}/profileComments
UserApi apiUsersIdProfileCommentsPost POST /api/users/{id}/profileComments
UserApi apiUsersIdRatedSongsGet GET /api/users/{id}/ratedSongs
UserApi apiUsersIdRatedSongsSongIdGet GET /api/users/{id}/ratedSongs/{songId}
UserApi apiUsersIdReportsPost POST /api/users/{id}/reports
UserApi apiUsersIdSettingsSettingNamePost POST /api/users/{id}/settings/{settingName}
UserApi apiUsersIdSongListsGet GET /api/users/{id}/songLists
UserApi apiUsersMessagesMessageIdGet GET /api/users/messages/{messageId}
UserApi apiUsersNamesGet GET /api/users/names
UserApi apiUsersProfileCommentsCommentIdDelete DELETE /api/users/profileComments/{commentId}
UserApi apiUsersProfileCommentsCommentIdPost POST /api/users/profileComments/{commentId}
VenueApi apiVenuesGet GET /api/venues
VenueApi apiVenuesIdDelete DELETE /api/venues/{id}
VenueApi apiVenuesIdReportsPost POST /api/venues/{id}/reports

Documentation for Models

Documentation for Authorization

Endpoints do not require authorization.

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author