PublicAPI - GitLite

KO | EN

gitlite — search

#javascript #python #hacktoberfest #ai #typescript #llm #android #linux #java #cli #kubernetes #vue #awesome-list #pytorch

PublicAPI

(★ 586)

Official Java implementation of the Hypixel Public API.

파일 탐색기

최종 버전 다운로드 (.zip)

- - maven.yml
- pom.xml
- pom.xml
- README.md
- pom.xml
- README.md
- pom.xml
- README.md
- pom.xml
- README.md
.gitignore
LICENSE
pom.xml
README.md

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/HypixelDev/PublicAPI

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd PublicAPI

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Maven (Java)

보통 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
JDK (Java) Java 프로젝트를 빌드/실행하려면 필요합니다.
Maven mvn 명령어를 쓰기 위한 빌드 도구입니다.

cd hypixel-api-core

이 프로젝트의 관련 파일이 하위 폴더 안에 있어서, 먼저 그 폴더로 이동합니다.

mvn clean install

Maven으로 의존성 설치와 빌드를 진행합니다.

✅ BUILD SUCCESS 메시지가 뜨면 성공입니다. target/ 폴더에 결과물이 생성됩니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

Hypixel Public API (Java)
======
[![Maven Package](https://github.com/HypixelDev/PublicAPI/actions/workflows/maven.yml/badge.svg)](https://github.com/HypixelDev/PublicAPI/actions/workflows/maven.yml)

This is a Java implementation of the Hypixel API. For discussing the API, requesting help or suggestions you can use the
GitHub [Discussions](https://github.com/HypixelDev/PublicAPI/discussions).

### Documentation

Hypixel Public API documentation can be found at [https://api.hypixel.net/](https://api.hypixel.net/). Java
documentation can be found in the code.

### Issues

GitHub issues should only be used to report bugs with the Java implementation of the Public API. If you have
issues or questions with using the Public API, you should post in the GitHub discussions, or use the Hypixel
[Code Creations](https://hypixel.net/forums/code-creations.65/) forum.

If you have an issue with the Public API itself, such as an error when trying to use a specific endpoint, you
can report this on the Hypixel Forums under the "Website" -> "Public API" option [here](https://hypixel.net/bug-reports/create).

### Usage

You can use this API as a dependency via the public Hypixel maven repo. You can also use
the [Example Code](https://github.com/HypixelDev/PublicAPI/tree/master/hypixel-api-example) as a good starting point.

#### Hypixel Maven Repo

```xml

<repository>
    <id>Hypixel</id>
    <url>https://repo.hypixel.net/repository/Hypixel/</url>
</repository>
```

This repo can also be used with Gradle.

```gradle
repositories {
    maven { url 'https://repo.hypixel.net/repository/Hypixel/' }
}
```

#### Transports

We include three built-in options for communicating with the Hypixel API, you can include either of these or even
include the core API directly and create your own instance of HypixelHTTPClient.

* [Apache HttpClient Transport](hypixel-api-transport-apache/README.md)
* [Unirest Java Transport](hypixel-api-transport-unirest/README.md)
* [Project Reactor Transport](hypixel-api-transport-reactor/README.md) (automatic rate-limiting by default)

### Dependencies

The Hypixel API Core implementation has the following dependencies:

* [Google Gson library - 2.10.1](https://mvnrepository.com/artifact/com.google.code.gson/gson)

Transports will also have dependencies where required.

### Contributing

When contributing changes to the Java API please provide as much detail on the changes and the reasons for them. We will

not accept changes that have no meaningful contribution to the project.