Commit 46756155 authored by Greg Messner's avatar Greg Messner
Browse files

Cleaned up markdown.

parent c7dc12e3
gitlab-api gitlab-api for Java
========== ===================
This project provides a full featured Java API for working with GitLab repositories via the standard GitLab REST API. This project provides a full featured Java API for working with GitLab repositories via the standard GitLab REST API.
It is quite simple to use, all you need is the URL to your GitLab server and the Private Token from your GitLab Account Settings page. Once you have that info it is as simple as: It is quite simple to use, all you need is the URL to your GitLab server and the Private Token from your GitLab Account Settings page. Once you have that info it is as simple as:
'''java ```java
// Create a GitLabApi instance to communicate with your GitLab server // Create a GitLabApi instance to communicate with your GitLab server
GitLabApi gitLabApi = new GitLabApi("http://your.gitlab.serbver.com", "YOUR_PRIVATE_TOKEN"); GitLabApi gitLabApi = new GitLabApi("http://your.gitlab.serbver.com", "YOUR_PRIVATE_TOKEN");
// Get the list of projects your account has access to // Get the list of projects your account has access to
List<Project> projects = gitLabApi.getProjectApi().getProjects(); List<Project> projects = gitLabApi.getProjectApi().getProjects();
''' ```
The API has been broken up into sub APIs classes to make it easier to learn and to separate concerns. Following is a list of the sub APIs along with a sample use of each API. See the Javadocs for a complete list of available methods for each sub API. The API has been broken up into sub APIs classes to make it easier to learn and to separate concerns. Following is a list of the sub APIs along with a sample use of each API. See the Javadocs for a complete list of available methods for each sub API.
Available Sub APIs Available Sub APIs
------------------ ------------------
''' ```
CommitsApi CommitsApi
GroupApi GroupApi
MergeRequestApi MergeRequestApi
ProjectApi ProjectApi
RepositoryApi RepositoryApi
UserApi UserApi
''' ```
CommitsApi: CommitsApi:
'''java ```java
// Get a list of commits associated with the specified branch // Get a list of commits associated with the specified branch
List<Commit> commits = gitLabApi.getgetCommitsApi().getCommits(1234, "new-feature"); List<Commit> commits = gitLabApi.getgetCommitsApi().getCommits(1234, "new-feature");
''' ```
GroupApi: GroupApi:
'''java ```java
// Get a list of groups that you have access to // Get a list of groups that you have access to
List<Group> groups = gitLabApi.getGroupApi().getGroups(); List<Group> groups = gitLabApi.getGroupApi().getGroups();
''' ```
MergeRequestApi: MergeRequestApi:
'''java ```java
// Get a list of the merge requests for the specified project // Get a list of the merge requests for the specified project
List<MergeRequest> mregeRequests = gitLabApi.getMergeRequestApi().getMergeRequests(1234); List<MergeRequest> mregeRequests = gitLabApi.getMergeRequestApi().getMergeRequests(1234);
''' ```
ProjectApi: ProjectApi:
'''java ```java
// Get a list of accessible projects // Get a list of accessible projects
public List<Project> projects = gitLabApi.getProjectApi().getProjects(); public List<Project> projects = gitLabApi.getProjectApi().getProjects();
''' ```
RepositoryApi: RepositoryApi:
'''java ```java
// Get a list of repository branches from a project, sorted by name alphabetically // Get a list of repository branches from a project, sorted by name alphabetically
List<Branch> branches = gitLabApi.getRepositoryApi().getBranches(); List<Branch> branches = gitLabApi.getRepositoryApi().getBranches();
''' ```
UserApi: UserApi:
'''java ```java
// Get the User info for user_id 1 // Get the User info for user_id 1
User user = gitLabApi.getUserApi().getUser(1); User user = gitLabApi.getUserApi().getUser(1);
''' ```
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment