Skip to content

Latest commit

 

History

History
146 lines (103 loc) · 5.17 KB

README.md

File metadata and controls

146 lines (103 loc) · 5.17 KB

swagger-java-client

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.swagger</groupId>
    <artifactId>swagger-java-client</artifactId>
    <version>1.0.0</version>
    <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "io.swagger:swagger-java-client:1.0.0"

Others

At first generate the JAR by executing:

mvn package

Then manually install the following JARs:

  • target/swagger-java-client-1.0.0.jar
  • target/lib/*.jar

Getting Started

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

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GroupApi;

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

public class GroupApiExample {

    public static void main(String[] args) {
        
        GroupApi apiInstance = new GroupApi();
        String id = "id_example"; // String | id
        Boolean uniquePeptides = true; // Boolean | uniquePeptides
        try {
            ProteinGroup result = apiInstance.getById(id, uniquePeptides);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupApi#getById");
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

All URIs are relative to http://localhost/

Class Method HTTP request Description
GroupApi getById GET /group/{id} getById
GroupApi getProteinGroupList GET /group/list getProteinGroupList
GroupApi getProteinGroupListForProtein GET /group/list/protein/{acc} getProteinGroupListForProtein
ModslistApi getModifications GET /mods/list getModifications
PeptideApi getById GET /peptide/{sequence} getById
PeptideApi getPeptideList GET /peptide/list getPeptideList
PeptideApi getPeptideListForProtein GET /peptide/list/protein/{acc} getPeptideListForProtein
ProteinApi getById GET /protein/{id} getById
ProteinApi getProteinCount GET /protein/count getProteinCount
ProteinApi getProteinList GET /protein/list getProteinList
ProteinApi getProteinListForPeptide GET /protein/list/peptide/{sequence} getProteinListForPeptide
ReleasesummaryApi getReleaseSummary GET /release/summary/list getReleaseSummary
ReleasesummaryApi getReleaseSummaryForSpecies GET /release/summary/species/${species} getReleaseSummaryForSpecies
SampleApi countTissues GET /sample/tissues/count/species/${species} countTissues
SampleApi getSpecies GET /sample/species getSpecies
SampleApi getTissues GET /sample/tissues/list getTissues
SampleApi getTissues_0 GET /sample/tissues/list/species/${species} getTissues
StatssummaryApi getSummary GET /stats/summary getSummary

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization. Authentication schemes defined for the API:

Recommendation

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

Author