AutomatedPackagePublishingSDK 15.5.6

Swagger Petstore - OpenAPI 3.0

The Swagger Petstore - OpenAPI 3.0 SDK for .NET provides access to the Swagger Petstore - OpenAPI 3.0 REST APIs from .NET applications.

This is a sample Pet Store Server based on the OpenAPI 3.0 specification. You can find out more about Swagger at https://swagger.io. In the third iteration of the pet store, we've switched to the design first approach! You can now help us improve the API whether it's by making changes to the definition itself or to the code. That way, with time, we can improve the API in general, and expose some of the new features in OAS3.

Some useful links:

• The Pet Store repository
• The source API definition for the Pet Store

Installation

Add the .NET SDK to your project from NuGet:

dotnet add package AutomatedPackagePublishingSDK

Quick Start

Dependency Injection

Register the client with IServiceCollection and resolve it from the container. The HttpClient is managed by IHttpClientFactory. Configure the client's behavior through SwaggerPetstoreOpenApi30ClientOptions.

services.AddSwaggerPetstoreOpenApi30Client(options =>
    {
        options.PetstoreAuth = "YOUR_API_KEY";
        options.ApiKey = "YOUR_API_KEY";
        options.Environment = ServerEnvironment.Production;
        // TODO: configure more client options here
    });

Direct Instantiation

Create the client by passing an HttpClient you manage yourself. Configure the client's behavior through SwaggerPetstoreOpenApi30ClientOptions.

var httpClient = new HttpClient();
// TODO: configure more client options here
var options =
    new SwaggerPetstoreOpenApi30ClientOptions
    {
        PetstoreAuth = "YOUR_API_KEY",
        ApiKey = "YOUR_API_KEY",
        Environment = ServerEnvironment.Production,
    };
var client = new SwaggerPetstoreOpenApi30Client(httpClient, options);

Usage

For code examples and error responses, see API Reference.

SDK map

This SDK ships a generated SDK map — sdk-map.md plus the map/ pages — a deterministic, lookup-oriented table of contents of the SDK's C# surface, generated by APIMatic alongside this SDK.

Read it before scanning the source. Whether you are an AI coding assistant or searching by hand, the map answers "what is the exact …" by lookup for every call-level contract, and for anything it does not carry it names the one file that does — so you never have to search the source tree:

• sdk-map.md — the index: client construction, servers/auth, the options/retry reference, the SDK-wide defaults the operation rows rely on, and link tables into map/.
• map/operations/ — one page per controller: the exact C# signature, the return type, the error type with its typed TryGet… accessors, and pagination — plus, per operation, a Type sources table naming the file that declares every type that operation mentions.

Model shapes — record fields with their JSON wire names, enum member names and wire values, OneOf/AnyOf union variants — are not duplicated in the map. Take the path from the operation's Type sources table and read the declaring file; it is the single source of truth and cannot go stale against the code.

Each operation row states what is specific to that operation. The SDK-wide defaults are stated once in sdk-map.md — throw-only (no Result-style no-throw variants), no pagination, the four fixed RawError accessors, the Default server group — and a row appears only where its operation departs from one. A row silent on pagination is telling you that operation has none.

The HTTP verb and route, and the endpoint's behavioural prose, live on the operation itself, in the source file named at the top of its operations page. Read them there when something needs them — wiring a mock, reading a provider log, or settling a rule about what you must pass.

Workflow: look the fact up in the map → where the map leaves something ambiguous, open the one source file the row names → the compiler is the backstop (a name that isn't in the map won't build). Don't scan or grep the tree to find things — the map is the locator.

Which one to reach for

The map and the API Reference answer different questions, and the map is generated from this SDK's source so it stays in lockstep with the code it describes.

Best Practices

License

This SDK is distributed under the MIT License.

Support

Refer to the API reference for detailed information on available operations with code samples.

For further assistance, please contact support at apiteam@swagger.io.