Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/microcks/microcks-java-client
Java client for accessing and using Microcks API
https://github.com/microcks/microcks-java-client
api-client contract-testing java microcks mocking
Last synced: about 1 month ago
JSON representation
Java client for accessing and using Microcks API
- Host: GitHub
- URL: https://github.com/microcks/microcks-java-client
- Owner: microcks
- License: apache-2.0
- Created: 2024-08-20T14:31:49.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-11-10T12:23:24.000Z (about 1 month ago)
- Last Synced: 2024-11-13T19:41:01.273Z (about 1 month ago)
- Topics: api-client, contract-testing, java, microcks, mocking
- Language: Java
- Homepage: https://microcks.io
- Size: 91.8 KB
- Stars: 4
- Watchers: 3
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY-INSIGHTS.yml
- Governance: GOVERNANCE.md
- Roadmap: ROADMAP.md
Awesome Lists containing this project
README
# Microcks Java Client
A Java Client or SDK that allows you to interact with the Microcks API. It has minimal dependencies and is easy to use.
[](https://github.com/microcks/microcks-java-client/actions)
[]((https://search.maven.org/artifact/io.github.microcks/microcks-java-client))
[](https://www.apache.org/licenses/LICENSE-2.0)
[](https://microcks.io/discord-invite/)
[](https://artifacthub.io/packages/search?repo=microcks)
[](https://landscape.cncf.io/?item=app-definition-and-development--application-definition-image-build--microcks)
## Build Status
Latest released version is `0.0.2`.
Current development version is `0.0.3-SNAPSHOT`.
#### Fossa license and security scans
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fmicrocks%2Fmicrocks-java-client?ref=badge_shield&issueType=license)
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fmicrocks%2Fmicrocks-java-client?ref=badge_shield&issueType=security)
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fmicrocks%2Fmicrocks-java-client?ref=badge_small)
#### OpenSSF best practices on Microcks core
[](https://bestpractices.coreinfrastructure.org/projects/7513)
[](https://securityscorecards.dev/viewer/?uri=github.com/microcks/microcks)
## Community
* [Documentation](https://microcks.io/documentation/tutorials/getting-started/)
* [Microcks Community](https://github.com/microcks/community) and community meeting
* Join us on [Discord](https://microcks.io/discord-invite/), on [GitHub Discussions](https://github.com/orgs/microcks/discussions) or [CNCF Slack #microcks channel](https://cloud-native.slack.com/archives/C05BYHW1TNJ)
To get involved with our community, please make sure you are familiar with the project's [Code of Conduct](./CODE_OF_CONDUCT.md).
## Versions
| Java Client | Microcks Version |
|-------------|------------------|
| `0.0.2` | `1.10.0` and + |
## How to use it?
### Include it into your project dependencies
If you're using Maven:
```xml
io.github.microcks
microcks-java-client
0.0.2
```
or if you're using Gradle:
```groovy
dependencies {
implementation 'io.github.microcks:microcks-java-client:0.0.2'
}
```
### Use it in your code
The API endpoints available on Microcks backend are split in different classes in the `io.github.microcks.client` package.
Each class represents a different part of the API but needs a common client configuration that is named `ApiClient`.
Here's the basic usage of the client where you configure the base URI of the Microcks API:
```java
ApiClient apiClient = new ApiClient();
apiClient.updateBaseUri("http://localhost:8585/api");
```
You can then easily use the client to interact with the different part of the API:
```java
ConfigApi configApi = new ConfigApi(apiClient);
KeycloakConfig config = configApi.getKeycloakConfig();
```
Check the[ ]Microcks' OpenAPI reference](https://microcks.io/documentation/references/apis/open-api/) for comprehensive
list of available endpoints and their parameters.
### Access to authenticated endpoints
If your Microcks backend instance has enabled AuthN and AUthZ and if you need to access authenticated endpoints,
we provide a `KeycloakClient` to first retrieve an oAuth token to use in following requests. You'll additionally need
the service account name and credentials to retrieve the token (see our documentation on
[how Microcks is using Service Accounts](https://microcks.io/documentation/explanations/service-account/)).
The flow is as follows:
```java
KeycloakConfig keycloak = configApi.getKeycloakConfig();
// If Keycloak is enabled on target backend.
if (config.isEnabled()) {
// Build the OAuth token endpoint - here using Keycloak public url but it could be another private one.
String tokenEndpoint = keycloak.getAuthServerUrl() + "/realms/" + keycloak.getRealm() + "/protocol/openid-connect/token";
final String oauthToken = KeycloakClient.connectAndGetOAuthToken("", "", tokenEndpoint);
// Set a new interceptor to add the Authorization header with the OAuth token.
apiClient.setRequestInterceptor(request -> request.header("Authorization", "Bearer " + oauthToken));
}
// Now you can use the client to create a protected resource.
JobApi jobApi = new JobApi(apiClient);
ImportJob importJob = new ImportJob();
importJob.setName("Hello Soap Service");
importJob.setRepositoryUrl("https://raw.githubusercontent.com/microcks/microcks/master/samples/HelloService-soapui-project.xml");
ImportJob result = jobApi.createImportJob(importJob);
```