diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..71c606c --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,58 @@ +# AGENTS.md — uapi-sdk-csharp + +This file tells AI coding agents how to use the **official .NET / C# SDK** +for the [uapis.cn](https://uapis.cn) public API platform. + +## What this package is + +Idiomatic .NET client for UAPI, targeting `net8.0`. Generated from the live +OpenAPI 3.1 spec at . + +## Install + +```bash +dotnet add package Uapi.Sdk +``` + +## Quick start + +```csharp +using Uapi.Sdk; + +var client = new UapiClient("https://uapis.cn"); +var weather = await client.Misc.GetMiscWeatherAsync(new GetMiscWeatherRequest +{ + City = "北京" +}); +Console.WriteLine(weather); +``` + +The client is grouped by tag (`Misc`, `Network`, `Text`, `Image`, `Social`, +`Translate`, `Search`, …). Method names match the OpenAPI `operationId`, +PascalCased and suffixed with `Async`. + +## Authentication + +Free-tier endpoints work with no key. Paid endpoints take a key: + +```csharp +var client = new UapiClient("https://uapis.cn", apiKey: "sk_…"); +``` + +## Errors + +Methods throw `UapiApiException` on non-2xx responses. The exception +carries `Code`, `Error`, and `RequestId` properties. 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-java`, `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/uapi-sdk-csharp.csproj b/uapi-sdk-csharp.csproj index d636611..4eb5190 100644 --- a/uapi-sdk-csharp.csproj +++ b/uapi-sdk-csharp.csproj @@ -5,8 +5,21 @@ enable false 1.0.5 + Uapi.Sdk + UAPI / AxT-Team + UAPI + Official .NET / C# SDK for UAPI / uapis.cn — typed .NET 8 wrapper around 100+ free public-API endpoints (network, text, image, social, translation, search). Generated from the live OpenAPI 3.1 spec. + uapi;uapis;sdk;dotnet;public-api;free-api;openapi;rest;client;agent;llm + https://uapis.cn/docs/sdk/csharp + https://github.com/AxT-Team/uapi-sdk-csharp + git + MIT + README.md + banner.png + +