Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adoptium/marketplace-api.adoptium.net
Adoptium Marketplace API 🚀
https://github.com/adoptium/marketplace-api.adoptium.net
adoptium api hacktoberfest java openjdk restful-api swagger temurin
Last synced: about 5 hours ago
JSON representation
Adoptium Marketplace API 🚀
- Host: GitHub
- URL: https://github.com/adoptium/marketplace-api.adoptium.net
- Owner: adoptium
- License: apache-2.0
- Created: 2023-10-19T19:18:58.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-04-30T21:05:58.000Z (5 months ago)
- Last Synced: 2024-05-01T11:30:31.425Z (5 months ago)
- Topics: adoptium, api, hacktoberfest, java, openjdk, restful-api, swagger, temurin
- Language: Kotlin
- Homepage: https://marketplace-api.adoptium.net
- Size: 7.24 MB
- Stars: 4
- Watchers: 12
- Forks: 3
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Adoptium marketplace
This repo contains:
- adoptium-marketplace-schema
- Schema definition for vendors to advertise their binaries
- adoptium-marketplace-client
- Client library for reading a repository with vendor data
- adoptium-marketplace-server
- Implementation of the adoptium marketplace API
- exampleRepositories
- Examples of a vendor repository
# Build
Build with
```shell
./mvnw clean install
```
# Testing
Tests rely on the data inside the `exampleRepositories` directory in order for tests to pass they must be signed. If you wish to modify test assets they need to be re-signed once they have been modified. The procedure would be as follows:
- Generate test keys
- Look in the `exampleRepositories/keys` directory for scripts that detail generating keys
- Re-sign assets
- Run `SignTestAssets` in the `adoptium-marketplace-utils` project.
# Repository validation
A repository can be validated using the `MarketplaceClient`. The client pulls a repository and validates its contents. For example:
```java
String publicKey = "-----BEGIN PUBLIC KEY-----\n" +
// Public key string here
"-----END PUBLIC KEY-----";
String repoUrl = "http://localhost:8080/repo";
try {
MarketplaceClient client = MarketplaceClient.build(repoUrl, SignatureType.BASE64_ENCODED, publicKey);
ReleaseList releaseList = client.readRepositoryData();
System.out.println("Found: " + releaseList.getReleases().size() + " releases");
} catch (Exception e) {
System.err.println("Validation failed");
e.printStackTrace();
}
```
Note that in this example we have used the default `SignatureType.BASE64_ENCODED` which specifies that the signature files are
base64 encoded. If you require non-base64 encoded use `SignatureType.SIG`.
An example of running this can be seen in RepoTest class in the `adoptium-marketplace-client` module. To validate your repo using this test,
edit it to add your public key and repo location, then run with:
```
VALIDATE_REPO=true ../mvnw test -Dtest=RepoTest#validateRepo
```
from inside the `adoptium-marketplace-client` directory.