Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kevinoid/appveyor-swagger-java
AppVeyor REST API Client (from Swagger, in Java)
https://github.com/kevinoid/appveyor-swagger-java
java openapi openapi-client swagger swagger-client swagger-codegen
Last synced: about 1 month ago
JSON representation
AppVeyor REST API Client (from Swagger, in Java)
- Host: GitHub
- URL: https://github.com/kevinoid/appveyor-swagger-java
- Owner: kevinoid
- License: other
- Created: 2017-01-05T03:14:55.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2021-06-28T13:39:12.000Z (over 3 years ago)
- Last Synced: 2023-12-21T14:19:32.713Z (11 months ago)
- Topics: java, openapi, openapi-client, swagger, swagger-client, swagger-codegen
- Language: Java
- Size: 2.77 MB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog.md
- License: LICENSE.txt
Awesome Lists containing this project
README
AppVeyor REST API Client (from Swagger, in Java)
================================================
[](https://ci.appveyor.com/project/kevinoid/appveyor-swagger-java)
[AppVeyor REST API](https://www.appveyor.com/docs/api/) client generated from
[the unofficial Swagger
definition](https://github.com/kevinoid/appveyor-swagger/) in Java. The
primary purpose of this project is to serve as a demonstration and test of the
Swagger definition using the Java language. It is also suitable for use as a
library to access the AppVeyor API from languages which run on the JVM. Users
should be aware that the generated classes are a bit clunky and the API is
_likely to change frequently_ as a result of updates to
[swagger-codegen](https://github.com/swagger-api/swagger-codegen) or the REST
API.
## Introductory Example
```java
import name.kevinlocke.appveyor.ApiClient;
import name.kevinlocke.appveyor.ApiException;
import name.kevinlocke.appveyor.api.ProjectApi;
import name.kevinlocke.appveyor.model.Build;
public class AppveyorApiExample {
public static void main(String[] args) {
ApiClient apiClient = new ApiClient();
apiClient.setApiKeyPrefix("Bearer");
// API Token from https://ci.appveyor.com/api-token
apiClient.setApiKey(apiToken);
ProjectApi projectApi = new ProjectApi(apiClient);
try {
Build build =
// Account name and slug from AppVeyor project URL
projectApi.getProjectLastBuild(accountName, projectSlug)
.getBuild();
System.out.println("Last build status: " + build.getStatus());
} catch (ApiException e) {
System.err.println("Error getting last build: " + e.getMessage());
}
}
}
```
## Usage
### Maven
To use this project as a dependency with [Maven](https://maven.apache.org),
add the following dependency to your project's `pom.xml`:
```xml
name.kevinlocke.appveyor
appveyor-swagger
0.1.0
```
### sbt
To use this project as a dependency with [sbt](http://www.scala-sbt.org)
add the following dependency to your project's `build.sbt`:
```scala
libraryDependencies += "name.kevinlocke.appveyor" % "appveyor-swagger" % "0.1.0"
```
### Gradle
To use this project as a dependency with [Gradle](https://gradle.org/),
add the following dependency to your project's `build.gradle`:
```groovy
compile "name.kevinlocke.appveyor:appveyor-swagger:0.1.0"
```
### Others
To use this project as a dependency of another build system, a
[JAR](https://docs.oracle.com/javase/8/docs/technotes/guides/jar/index.html)
can be created by running the following commands:
```sh
git clone --branch v0.1.0 https://github.com/kevinoid/appveyor-swagger-java.git
cd appveyor-swagger-java
mvn package
```
The generated JAR file will be at `target/appveyor-swagger-0.1.0.jar`.
## Documentation
The [project documentation](https://kevinoid.github.io/appveyor-swagger-java/)
includes [Javadoc](https://kevinoid.github.io/appveyor-swagger-java/apidocs/)
and [Swagger-generated endpoint and model
documentation](https://kevinoid.github.io/appveyor-swagger-java/swaggerdocs/#Documentation_for_API_Endpoints).
There is also [Swagger API
Documentation](https://kevinoid.github.io/appveyor-swagger).
## Testing
Running the tests defined in this project requires an AppVeyor account. The
[API Token](https://ci.appveyor.com/api-token) must be set in the environment
variable `$APPVEYOR_API_TOKEN` when running the tests. This can be
accomplished as follows:
```sh
APPVEYOR_API_TOKEN=deadbeef mvn test
```
## License
This library is available under the terms of the
[MIT License](https://opensource.org/licenses/MIT).