diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..0c30e43 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,71 @@ +# AGENTS.md — uapi-sdk-java + +This file tells AI coding agents how to use the **official Java SDK** for +the [uapis.cn](https://uapis.cn) public API platform. + +## What this artifact is + +Idiomatic Java client for UAPI. Generated from the live OpenAPI 3.1 spec at + — class names, method names, and parameter +shapes track the real API. + +## Install + +Maven (`pom.xml`): + +```xml + + cn.uapis + uapi-sdk-java + 0.1.17 + +``` + +Gradle (`build.gradle.kts`): + +```kotlin +implementation("cn.uapis:uapi-sdk-java:0.1.17") +``` + +## Quick start + +```java +import cn.uapis.UapiClient; +import cn.uapis.api.MiscApi; +import cn.uapis.model.GetMiscWeatherRequest; + +UapiClient client = new UapiClient("https://uapis.cn"); +MiscApi misc = new MiscApi(client); +var resp = misc.getMiscWeather(new GetMiscWeatherRequest().city("北京")); +System.out.println(resp); +``` + +The SDK is grouped by tag (`MiscApi`, `NetworkApi`, `TextApi`, `ImageApi`, +`SocialApi`, `TranslateApi`, `SearchApi`, …). Method names match the +OpenAPI `operationId`, camelCased. + +## Authentication + +Free-tier endpoints work with no key. Paid endpoints take a key: + +```java +UapiClient client = new UapiClient("https://uapis.cn", "sk_…"); +``` + +## Errors + +Methods throw `UapiApiException` (subclass of `IOException`) on non-2xx +responses. The exception carries `code`, `error`, and `requestId` fields. +Surface `error` verbatim. + +## Rate limits + +Headers `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset`, +`Retry-After` are exposed on response headers. Honor them. + +## Related repos + +- MCP server: . +- Skills bundle: . +- Other languages: `uapi-sdk-typescript`, `uapi-sdk-python`, `uapi-sdk-go`, + `uapi-sdk-rust`, `uapi-sdk-csharp`, `uapi-sdk-cpp`, `uapi-sdk-php`. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..4e7b5fa --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2025 AxT-Team / UAPI + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/pom.xml b/pom.xml index 8ce3c29..ccbdaff 100644 --- a/pom.xml +++ b/pom.xml @@ -8,6 +8,29 @@ 17 17 + UAPI SDK for Java + Official Java SDK for UAPI / uapis.cn — typed Java 17+ wrapper around 100+ free public-API endpoints (network, text, image, social, translation, search). Generated from the live OpenAPI 3.1 spec. + https://uapis.cn/docs/sdk/java + + + MIT License + https://github.com/AxT-Team/uapi-sdk-java/blob/main/LICENSE + + + + + uapi + UAPI + dev@uapis.cn + AxT-Team + https://uapis.cn + + + + scm:git:git://github.com/AxT-Team/uapi-sdk-java.git + scm:git:ssh://github.com:AxT-Team/uapi-sdk-java.git + https://github.com/AxT-Team/uapi-sdk-java/tree/main + com.squareup.okhttp3