https://github.com/adoptium/api.adoptium.net

Adoptium API 🚀
https://github.com/adoptium/api.adoptium.net

adoptium api hacktoberfest java openjdk restful-api swagger temurin

Last synced: about 1 month ago
JSON representation

Adoptium API 🚀

• Host: GitHub
• URL: https://github.com/adoptium/api.adoptium.net
• Owner: adoptium
• License: apache-2.0
• Created: 2021-03-19T13:29:14.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-05-01T00:31:24.000Z (7 months ago)
• Last Synced: 2024-05-01T11:30:29.097Z (7 months ago)
• Topics: adoptium, api, hacktoberfest, java, openjdk, restful-api, swagger, temurin
• Language: Kotlin
• Homepage: https://api.adoptium.net
• Size: 7.02 MB
• Stars: 31
• Watchers: 14
• Forks: 26
• Open Issues: 24
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        

# Adoptium API

**NOTICE:** [AdoptOpenJDK API v3](https://github.com/AdoptOpenJDK/openjdk-api-v3/blob/master/README.md) has been deprecated as part of the move to Eclipse Foundation and rebrand to Adoptium.

## Overview

The Adoptium API provides a way to consume JSON information about the Adoptium Temurin releases and nightly builds.  

Sign up to the [`#api` Slack channel](https://adoptium.net/slack/) where major API updates will be announced, and visit [adoptium.net](https://adoptium.net) to find out more about the community.

## Usage

The API is documented using Swagger.  The Swagger documentation can be viewed at: [api.adoptium.net/swagger-ui](https://api.adoptium.net/swagger-ui).

The Open API spec for this can be viewed at: [api.adoptium.net/openapi](https://api.adoptium.net/openapi)

For more information, including example queries, please look at the [API cookbook](https://github.com/adoptium/api.adoptium.net/blob/main/docs/cookbook.adoc).

## Who's using the Adoptium API?

The Adoptium API (and its predecessor at AdoptOpenJDK) has served over 200 million downloads by a wide variety consumers, from individuals to organizations.

Check the [Download Statistics Dashboard](https://dash.adoptium.net/) for the latest numbers.  

The following list highlights a small subset of consumers and their use-cases:

- [Adoptium Website](https://adoptium.net/) - the API drives the release listings on the AdoptOpenJDK website allowing individuals to download the JDK distribution of their choice.

- [Gradle](https://docs.gradle.org/) - the Gradle project defaults to use the API for its [toolchains](https://docs.gradle.org/current/userguide/toolchains.html#sec:provisioning) feature.

- [Update Watcher for Adoptium & AdoptOpenJDK](https://github.com/tushev/aojdk-updatewatcher) - uses the API to automatically manage the JDK installations on an individual's machine.

## Version Bump

When a new version of Java is released, the version at [Versions.kt](adoptium-models-parent/adoptium-api-v3-models/src/main/kotlin/net/adoptium/api/v3/models/Versions.kt),

or by setting the property `LATEST_JAVA_VERSION` on the deployment.

## Development

To learn more about how we build & run the API, check out [CONTRIBUTING.md](CONTRIBUTING.md) and the [FAQs](FAQ.md).