Skip to content

Repository files navigation

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:

importio.swagger.client.*;
importio.swagger.client.auth.*;
importio.swagger.client.model.*;
importio.swagger.client.api.AppsApi;
importjava.io.File;
importjava.util.*;
publicclassAppsApiExample {
publicstaticvoidmain(String[] args) {
AppsApiapiInstance = newAppsApi();
Stringapp = "app_example"; // String | Name of the app.try {
apiInstance.appsAppDelete(app);
} catch (ApiExceptione) {
System.err.println("Exception when calling AppsApi#appsAppDelete");
e.printStackTrace();
}
}
}

Documentation for API Endpoints

All URIs are relative to https://127.0.0.1:8080/v1

ClassMethodHTTP requestDescription
AppsApiappsAppDeleteDELETE /apps/{app}Delete an app.
AppsApiappsAppGetGET /apps/{app}Get information for a app.
AppsApiappsAppPatchPATCH /apps/{app}Updates an app.
AppsApiappsGetGET /appsGet all app names.
AppsApiappsPostPOST /appsPost new app
CallApiappsAppCallsCallGetGET /apps/{app}/calls/{call}Get call information
CallApiappsAppCallsCallLogGetGET /apps/{app}/calls/{call}/logGet call logs
CallApiappsAppCallsGetGET /apps/{app}/callsGet app-bound calls.
LogApiappsAppCallsCallLogGetGET /apps/{app}/calls/{call}/logGet call logs
RoutesApiappsAppRoutesGetGET /apps/{app}/routesGet route list by app name.
RoutesApiappsAppRoutesPostPOST /apps/{app}/routesCreate new Route
RoutesApiappsAppRoutesRouteDeleteDELETE /apps/{app}/routes/{route}Deletes the route
RoutesApiappsAppRoutesRouteGetGET /apps/{app}/routes/{route}Gets route by name
RoutesApiappsAppRoutesRoutePatchPATCH /apps/{app}/routes/{route}Update a Route, Fails if the route or app does not exist. Accepts partial updates / skips validation of zero values.
RoutesApiappsAppRoutesRoutePutPUT /apps/{app}/routes/{route}Create a Route if it does not exist. Update if it does. Will also create app if it does not exist. Put does not skip validation of zero values

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 issues.

Author

About

Fn project Java binding

Topics

Resources

Stars

7 stars

Watchers

3 watching

Forks

Releases

Packages

Used by

Contributors

Languages