java-gitea-api

Requirements

Building the API client library requires Maven to be installed.

Installation

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

mvn install

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

mvn deploy

Refer to the official documentation for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
    <groupId>io.gitea</groupId>
    <artifactId>java-gitea-api</artifactId>
    <version>1.0.0</version>
    <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "io.gitea:java-gitea-api:1.0.0"

Others

At first generate the JAR by executing:

mvn package

Then manually install the following JARs:

• target/java-gitea-api-1.0.0.jar
• target/lib/*.jar

Getting Started

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

import io.gitea.*;
import io.gitea.auth.*;
import io.gitea.model.*;
import io.gitea.api.AdminApi;

import java.io.File;
import java.util.*;

public class AdminApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: AccessToken
        ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken");
        AccessToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //AccessToken.setApiKeyPrefix("Token");

        // Configure API key authorization: AuthorizationHeaderToken
        ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken");
        AuthorizationHeaderToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //AuthorizationHeaderToken.setApiKeyPrefix("Token");

        // Configure HTTP basic authorization: BasicAuth
        HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
        BasicAuth.setUsername("YOUR USERNAME");
        BasicAuth.setPassword("YOUR PASSWORD");

        // Configure API key authorization: Token
        ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token");
        Token.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //Token.setApiKeyPrefix("Token");

        AdminApi apiInstance = new AdminApi();
        String username = "username_example"; // String | username of the user that will own the created organization
        try {
            Organization result = apiInstance.adminCreateOrg(username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AdminApi#adminCreateOrg");
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

All URIs are relative to http://localhost/api/v1

Class	Method	HTTP request	Description
AdminApi	adminCreateOrg	POST /admin/users/{username}/orgs	Create an organization
AdminApi	adminCreatePublicKey	POST /admin/users/{username}/keys	Add a public key on behalf of a user
AdminApi	adminCreateRepo	POST /admin/users/{username}/repos	Create a repository on behalf a user
AdminApi	adminCreateUser	POST /admin/users	Create a user
AdminApi	adminDeleteUser	DELETE /admin/users/{username}	Delete a user
AdminApi	adminDeleteUserPublicKey	DELETE /admin/users/{username}/keys/{id}	Delete a user's public key
AdminApi	adminEditUser	PATCH /admin/users/{username}	Edit an existing user
IssueApi	issueAddLabel	POST /repos/{owner}/{repo}/issues/{index}/labels	Add a label to an issue
IssueApi	issueAddTime	POST /repos/{owner}/{repo}/issues/{id}/times	Add a tracked time to a issue
IssueApi	issueClearLabels	DELETE /repos/{owner}/{repo}/issues/{index}/labels	Remove all labels from an issue
IssueApi	issueCreateComment	POST /repos/{owner}/{repo}/issues/{index}/comments	Add a comment to an issue
IssueApi	issueCreateIssue	POST /repos/{owner}/{repo}/issues	Create an issue
IssueApi	issueCreateLabel	POST /repos/{owner}/{repo}/labels	Create a label
IssueApi	issueCreateMilestone	POST /repos/{owner}/{repo}/milestones	Create a milestone
IssueApi	issueDeleteComment	DELETE /repos/{owner}/{repo}/issues/comments/{id}	Delete a comment
IssueApi	issueDeleteCommentDeprecated	DELETE /repos/{owner}/{repo}/issues/{index}/comments/{id}	Delete a comment
IssueApi	issueDeleteLabel	DELETE /repos/{owner}/{repo}/labels/{id}	Delete a label
IssueApi	issueDeleteMilestone	DELETE /repos/{owner}/{repo}/milestones/{id}	Delete a milestone
IssueApi	issueEditComment	PATCH /repos/{owner}/{repo}/issues/comments/{id}	Edit a comment
IssueApi	issueEditCommentDeprecated	PATCH /repos/{owner}/{repo}/issues/{index}/comments/{id}	Edit a comment
IssueApi	issueEditIssue	PATCH /repos/{owner}/{repo}/issues/{index}	Edit an issue
IssueApi	issueEditIssueDeadline	POST /repos/{owner}/{repo}/issues/{index}/deadline	Set an issue deadline. If set to null, the deadline is deleted.
IssueApi	issueEditLabel	PATCH /repos/{owner}/{repo}/labels/{id}	Update a label
IssueApi	issueEditMilestone	PATCH /repos/{owner}/{repo}/milestones/{id}	Update a milestone
IssueApi	issueGetComments	GET /repos/{owner}/{repo}/issues/{index}/comments	List all comments on an issue
IssueApi	issueGetIssue	GET /repos/{owner}/{repo}/issues/{index}	Get an issue
IssueApi	issueGetLabel	GET /repos/{owner}/{repo}/labels/{id}	Get a single label
IssueApi	issueGetLabels	GET /repos/{owner}/{repo}/issues/{index}/labels	Get an issue's labels
IssueApi	issueGetMilestone	GET /repos/{owner}/{repo}/milestones/{id}	Get a milestone
IssueApi	issueGetMilestonesList	GET /repos/{owner}/{repo}/milestones	Get all of a repository's milestones
IssueApi	issueGetRepoComments	GET /repos/{owner}/{repo}/issues/comments	List all comments in a repository
IssueApi	issueListIssues	GET /repos/{owner}/{repo}/issues	List a repository's issues
IssueApi	issueListLabels	GET /repos/{owner}/{repo}/labels	Get all of a repository's labels
IssueApi	issueRemoveLabel	DELETE /repos/{owner}/{repo}/issues/{index}/labels/{id}	Remove a label from an issue
IssueApi	issueReplaceLabels	PUT /repos/{owner}/{repo}/issues/{index}/labels	Replace an issue's labels
IssueApi	issueTrackedTimes	GET /repos/{owner}/{repo}/issues/{id}/times	List an issue's tracked times
MiscellaneousApi	getVersion	GET /version	Returns the version of the Gitea application
MiscellaneousApi	renderMarkdown	POST /markdown	Render a markdown document as HTML
MiscellaneousApi	renderMarkdownRaw	POST /markdown/raw	Render raw markdown as HTML
OrganizationApi	createOrgRepo	POST /org/{org}/repos	Create a repository in an organization
OrganizationApi	orgAddTeamMember	PUT /teams/{id}/members/{username}	Add a team member
OrganizationApi	orgAddTeamRepository	PUT /teams/{id}/repos/{org}/{repo}	Add a repository to a team
OrganizationApi	orgConcealMember	DELETE /orgs/{org}/public_members/{username}	Conceal a user's membership
OrganizationApi	orgCreateHook	POST /orgs/{org}/hooks/	Create a hook
OrganizationApi	orgCreateTeam	POST /orgs/{org}/teams	Create a team
OrganizationApi	orgDeleteHook	DELETE /orgs/{org}/hooks/{id}	Delete a hook
OrganizationApi	orgDeleteMember	DELETE /orgs/{org}/members/{username}	Remove a member from an organization
OrganizationApi	orgDeleteTeam	DELETE /teams/{id}	Delete a team
OrganizationApi	orgEdit	PATCH /orgs/{org}	Edit an organization
OrganizationApi	orgEditHook	PATCH /orgs/{org}/hooks/{id}	Update a hook
OrganizationApi	orgEditTeam	PATCH /teams/{id}	Edit a team
OrganizationApi	orgGet	GET /orgs/{org}	Get an organization
OrganizationApi	orgGetHook	GET /orgs/{org}/hooks/{id}	Get a hook
OrganizationApi	orgGetTeam	GET /teams/{id}	Get a team
OrganizationApi	orgIsMember	GET /orgs/{org}/members/{username}	Check if a user is a member of an organization
OrganizationApi	orgIsPublicMember	GET /orgs/{org}/public_members/{username}	Check if a user is a public member of an organization
OrganizationApi	orgListCurrentUserOrgs	GET /user/orgs	List the current user's organizations
OrganizationApi	orgListHooks	GET /orgs/{org}/hooks	List an organization's webhooks
OrganizationApi	orgListMembers	GET /orgs/{org}/members	List an organization's members
OrganizationApi	orgListPublicMembers	GET /orgs/{org}/public_members	List an organization's public members
OrganizationApi	orgListRepos	GET /orgs/{org}/repos	List an organization's repos
OrganizationApi	orgListTeamMembers	GET /teams/{id}/members	List a team's members
OrganizationApi	orgListTeamRepos	GET /teams/{id}/repos	List a team's repos
OrganizationApi	orgListTeams	GET /orgs/{org}/teams	List an organization's teams
OrganizationApi	orgListUserOrgs	GET /user/{username}/orgs	List a user's organizations
OrganizationApi	orgPublicizeMember	PUT /orgs/{org}/public_members/{username}	Publicize a user's membership
OrganizationApi	orgRemoveTeamMember	DELETE /teams/{id}/members/{username}	Remove a team member
OrganizationApi	orgRemoveTeamRepository	DELETE /teams/{id}/repos/{org}/{repo}	Remove a repository from a team
RepositoryApi	createCurrentUserRepo	POST /user/repos	Create a repository
RepositoryApi	createFork	POST /repos/{owner}/{repo}/forks	Fork a repository
RepositoryApi	listForks	GET /repos/{owner}/{repo}/forks	List a repository's forks
RepositoryApi	repoAddCollaborator	PUT /repos/{owner}/{repo}/collaborators/{collaborator}	Add a collaborator to a repository
RepositoryApi	repoCheckCollaborator	GET /repos/{owner}/{repo}/collaborators/{collaborator}	Check if a user is a collaborator of a repository
RepositoryApi	repoCreateHook	POST /repos/{owner}/{repo}/hooks	Create a hook
RepositoryApi	repoCreateKey	POST /repos/{owner}/{repo}/keys	Add a key to a repository
RepositoryApi	repoCreatePullRequest	POST /repos/{owner}/{repo}/pulls	Create a pull request
RepositoryApi	repoCreateRelease	POST /repos/{owner}/{repo}/releases	Create a release
RepositoryApi	repoCreateReleaseAttachment	POST /repos/{owner}/{repo}/releases/{id}/assets	Create a release attachment
RepositoryApi	repoCreateStatus	POST /repos/{owner}/{repo}/statuses/{sha}	Create a commit status
RepositoryApi	repoDelete	DELETE /repos/{owner}/{repo}	Delete a repository
RepositoryApi	repoDeleteCollaborator	DELETE /repos/{owner}/{repo}/collaborators/{collaborator}	Delete a collaborator from a repository
RepositoryApi	repoDeleteHook	DELETE /repos/{owner}/{repo}/hooks/{id}	Delete a hook in a repository
RepositoryApi	repoDeleteKey	DELETE /repos/{owner}/{repo}/keys/{id}	Delete a key from a repository
RepositoryApi	repoDeleteRelease	DELETE /repos/{owner}/{repo}/releases/{id}	Delete a release
RepositoryApi	repoDeleteReleaseAttachment	DELETE /repos/{owner}/{repo}/releases/{id}/assets/{attachment_id}	Delete a release attachment
RepositoryApi	repoEditHook	PATCH /repos/{owner}/{repo}/hooks/{id}	Edit a hook in a repository
RepositoryApi	repoEditPullRequest	PATCH /repos/{owner}/{repo}/pulls/{index}	Update a pull request
RepositoryApi	repoEditRelease	PATCH /repos/{owner}/{repo}/releases/{id}	Update a release
RepositoryApi	repoEditReleaseAttachment	PATCH /repos/{owner}/{repo}/releases/{id}/assets/{attachment_id}	Edit a release attachment
RepositoryApi	repoGet	GET /repos/{owner}/{repo}	Get a repository
RepositoryApi	repoGetArchive	GET /repos/{owner}/{repo}/archive/{archive}	Get an archive of a repository
RepositoryApi	repoGetBranch	GET /repos/{owner}/{repo}/branches/{branch}	List a repository's branches
RepositoryApi	repoGetByID	GET /repositories/{id}	Get a repository by id
RepositoryApi	repoGetCombinedStatusByRef	GET /repos/{owner}/{repo}/commits/{ref}/statuses	Get a commit's combined status, by branch/tag/commit reference
RepositoryApi	repoGetEditorConfig	GET /repos/{owner}/{repo}/editorconfig/{filepath}	Get the EditorConfig definitions of a file in a repository
RepositoryApi	repoGetHook	GET /repos/{owner}/{repo}/hooks/{id}	Get a hook
RepositoryApi	repoGetKey	GET /repos/{owner}/{repo}/keys/{id}	Get a repository's key by id
RepositoryApi	repoGetPullRequest	GET /repos/{owner}/{repo}/pulls/{index}	Get a pull request
RepositoryApi	repoGetRawFile	GET /repos/{owner}/{repo}/raw/{filepath}	Get a file from a repository
RepositoryApi	repoGetRelease	GET /repos/{owner}/{repo}/releases/{id}	Get a release
RepositoryApi	repoGetReleaseAttachment	GET /repos/{owner}/{repo}/releases/{id}/assets/{attachment_id}	Get a release attachment
RepositoryApi	repoListBranches	GET /repos/{owner}/{repo}/branches	List a repository's branches
RepositoryApi	repoListCollaborators	GET /repos/{owner}/{repo}/collaborators	List a repository's collaborators
RepositoryApi	repoListHooks	GET /repos/{owner}/{repo}/hooks	List the hooks in a repository
RepositoryApi	repoListKeys	GET /repos/{owner}/{repo}/keys	List a repository's keys
RepositoryApi	repoListPullRequests	GET /repos/{owner}/{repo}/pulls	List a repo's pull requests
RepositoryApi	repoListReleaseAttachments	GET /repos/{owner}/{repo}/releases/{id}/assets	List release's attachments
RepositoryApi	repoListReleases	GET /repos/{owner}/{repo}/releases	List a repo's releases
RepositoryApi	repoListStargazers	GET /repos/{owner}/{repo}/stargazers	List a repo's stargazers
RepositoryApi	repoListStatuses	GET /repos/{owner}/{repo}/statuses/{sha}	Get a commit's statuses
RepositoryApi	repoListSubscribers	GET /repos/{owner}/{repo}/subscribers	List a repo's watchers
RepositoryApi	repoMergePullRequest	POST /repos/{owner}/{repo}/pulls/{index}/merge	Merge a pull request
RepositoryApi	repoMigrate	POST /repos/migrate	Migrate a remote git repository
RepositoryApi	repoMirrorSync	POST /repos/{owner}/{repo}/mirror-sync	Sync a mirrored repository
RepositoryApi	repoPullRequestIsMerged	GET /repos/{owner}/{repo}/pulls/{index}/merge	Check if a pull request has been merged
RepositoryApi	repoSearch	GET /repos/search	Search for repositories
RepositoryApi	repoTestHook	POST /repos/{owner}/{repo}/hooks/{id}/tests	Test a push webhook
RepositoryApi	repoTrackedTimes	GET /repos/{owner}/{repo}/times	List a repo's tracked times
RepositoryApi	topicSearch	GET /topics/search	search topics via keyword
RepositoryApi	userCurrentCheckSubscription	GET /repos/{owner}/{repo}/subscription	Check if the current user is watching a repo
RepositoryApi	userCurrentDeleteSubscription	DELETE /repos/{owner}/{repo}/subscription	Unwatch a repo
RepositoryApi	userCurrentPutSubscription	PUT /repos/{owner}/{repo}/subscription	Watch a repo
UserApi	createCurrentUserRepo	POST /user/repos	Create a repository
UserApi	userAddEmail	POST /user/emails	Add email addresses
UserApi	userCheckFollowing	GET /users/{follower}/following/{followee}	Check if one user is following another user
UserApi	userCreateToken	POST /users/{username}/tokens	Create an access token
UserApi	userCurrentCheckFollowing	GET /user/following/{username}	Check whether a user is followed by the authenticated user
UserApi	userCurrentCheckStarring	GET /user/starred/{owner}/{repo}	Whether the authenticated is starring the repo
UserApi	userCurrentDeleteFollow	DELETE /user/following/{username}	Unfollow a user
UserApi	userCurrentDeleteGPGKey	DELETE /user/gpg_keys/{id}	Remove a GPG key
UserApi	userCurrentDeleteKey	DELETE /user/keys/{id}	Delete a public key
UserApi	userCurrentDeleteStar	DELETE /user/starred/{owner}/{repo}	Unstar the given repo
UserApi	userCurrentGetGPGKey	GET /user/gpg_keys/{id}	Get a GPG key
UserApi	userCurrentGetKey	GET /user/keys/{id}	Get a public key
UserApi	userCurrentListFollowers	GET /user/followers	List the authenticated user's followers
UserApi	userCurrentListFollowing	GET /user/following	List the users that the authenticated user is following
UserApi	userCurrentListGPGKeys	GET /user/gpg_keys	List the authenticated user's GPG keys
UserApi	userCurrentListKeys	GET /user/keys	List the authenticated user's public keys
UserApi	userCurrentListRepos	GET /user/repos	List the repos that the authenticated user owns or has access to
UserApi	userCurrentListStarred	GET /user/starred	The repos that the authenticated user has starred
UserApi	userCurrentListSubscriptions	GET /user/subscriptions	List repositories watched by the authenticated user
UserApi	userCurrentPostGPGKey	POST /user/gpg_keys	Create a GPG key
UserApi	userCurrentPostKey	POST /user/keys	Create a public key
UserApi	userCurrentPutFollow	PUT /user/following/{username}	Follow a user
UserApi	userCurrentPutStar	PUT /user/starred/{owner}/{repo}	Star the given repo
UserApi	userCurrentTrackedTimes	GET /user/times	List the current user's tracked times
UserApi	userDeleteAccessToken	DELETE /users/{username}/tokens/{token}	delete an access token
UserApi	userDeleteEmail	DELETE /user/emails	Delete email addresses
UserApi	userGet	GET /users/{username}	Get a user
UserApi	userGetCurrent	GET /user	Get the authenticated user
UserApi	userGetTokens	GET /users/{username}/tokens	List the authenticated user's access tokens
UserApi	userListEmails	GET /user/emails	List the authenticated user's email addresses
UserApi	userListFollowers	GET /users/{username}/followers	List the given user's followers
UserApi	userListFollowing	GET /users/{username}/following	List the users that the given user is following
UserApi	userListGPGKeys	GET /users/{username}/gpg_keys	List the given user's GPG keys
UserApi	userListKeys	GET /users/{username}/keys	List the given user's public keys
UserApi	userListRepos	GET /users/{username}/repos	List the repos owned by the given user
UserApi	userListStarred	GET /users/{username}/starred	The repos that the given user has starred
UserApi	userListSubscriptions	GET /users/{username}/subscriptions	List the repositories watched by a user
UserApi	userSearch	GET /users/search	Search for users
UserApi	userTrackedTimes	GET /repos/{owner}/{repo}/times/{user}	List a user's tracked times in a repo

Documentation for Models

• AddCollaboratorOption
• AddTimeOption
• Attachment
• Branch
• Comment
• CreateEmailOption
• CreateForkOption
• CreateGPGKeyOption
• CreateHookOption
• CreateIssueCommentOption
• CreateIssueOption
• CreateKeyOption
• CreateLabelOption
• CreateMilestoneOption
• CreateOrgOption
• CreatePullRequestOption
• CreateReleaseOption
• CreateRepoOption
• CreateStatusOption
• CreateTeamOption
• CreateUserOption
• DeleteEmailOption
• DeployKey
• EditAttachmentOptions
• EditDeadlineOption
• EditHookOption
• EditIssueCommentOption
• EditIssueOption
• EditLabelOption
• EditMilestoneOption
• EditOrgOption
• EditPullRequestOption
• EditReleaseOption
• EditTeamOption
• EditUserOption
• Email
• GPGKey
• GPGKeyEmail
• Issue
• IssueDeadline
• IssueLabelsOption
• Label
• MarkdownOption
• MigrateRepoForm
• Milestone
• Organization
• PRBranchInfo
• PayloadCommit
• PayloadCommitVerification
• PayloadUser
• Permission
• PublicKey
• PullRequest
• PullRequestMeta
• Release
• Repository
• SearchResults
• ServerVersion
• Status
• Team
• TrackedTime
• User
• WatchInfo

Documentation for Authorization

Authentication schemes defined for the API:

AccessToken

• Type: API key
• API key parameter name: access_token
• Location: URL query string

AuthorizationHeaderToken

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

BasicAuth

• Type: HTTP basic authentication

Token

• Type: API key
• API key parameter name: token
• Location: URL query string

Recommendation

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

Author