Akademi C# · Pelajaran

OpenAPI, Pemversian & Penggunaan

Jana dokumentasi Swagger/OpenAPI, versikan API dan gunakan API Minimal ke Azure App Service atau bekas.

Pelajaran 4 daripada 413 langkah

OpenAPI, Pemversian & Penggunaan ialah pelajaran Akademi C# percuma di CoddyKit. Ini ialah pelajaran 4 daripada 4. Anda boleh membaca keseluruhan pelajaran di bawah secara percuma — kemudian berlatih secara praktikal dalam pelayar menggunakan penyunting kod terbina dalam dan tutor kecerdasan buatan 24/7. Pelajaran ini merupakan sebahagian daripada laluan pembelajaran Akademi C#, dan kemajuan anda disegerakkan merentas web serta aplikasi CoddyKit. Kursus Akademi C# merangkumi sejumlah 4 pelajaran.

OpenAPI dalam API Minimal

OpenAPI (dahulunya Swagger) menjana dokumentasi API interaktif. Dalam .NET 9, AddOpenApi() tersedia secara terbina dalam. Bagi versi terdahulu, gunakan Swashbuckle.AspNetCore.

Menambahkan Swagger dengan Swashbuckle

Pasang Swashbuckle, konfigurasikannya dalam perkhidmatan dan tambahkan perisian tengah untuk menyediakan spesifikasi serta UI Swagger.

// dotnet add package Swashbuckle.AspNetCore

builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen(opt =>
    opt.SwaggerDoc("v1", new() { Title = "Products API", Version = "v1" }));

var app = builder.Build();

if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
    app.UseSwaggerUI();
}

Menganotasi Titik Akhir untuk OpenAPI

Gunakan Produces, ProducesProblem, WithSummary dan WithDescription untuk memperkaya spesifikasi OpenAPI yang dijana.

app.MapGet("/products/{id}", GetProduct)
   .WithName("GetProductById")
   .WithSummary("Get a product by ID")
   .WithDescription("Returns the product matching the given numeric ID.")
   .Produces<ProductDto>(200)
   .Produces<ProblemDetails>(404)
   .WithTags("Products");

Pemversian API dengan Kumpulan Laluan

Strategi pemversian mudah menggunakan kumpulan laluan yang diawali dengan versi. Tiada pakej tambahan diperlukan untuk pemversian asas.

var v1 = app.MapGroup("/api/v1").WithTags("v1");
var v2 = app.MapGroup("/api/v2").WithTags("v2");

v1.MapGet("/products", GetProductsV1);
v2.MapGet("/products", GetProductsV2); // different DTO shape

// Clients use /api/v1/products or /api/v2/products

Asp.Versioning untuk Pemversian Pengepala atau Pertanyaan

Pakej Asp.Versioning.Http menambahkan pemversian berasaskan rentetan pertanyaan, pengepala dan segmen URL kepada API Minimal dengan integrasi OpenAPI sepenuhnya.

// dotnet add package Asp.Versioning.Http

builder.Services.AddApiVersioning(opt =>
{
    opt.DefaultApiVersion = new ApiVersion(1, 0);
    opt.AssumeDefaultVersionWhenUnspecified = true;
    opt.ApiVersionReader = new QueryStringApiVersionReader("api-version");
});

// /products?api-version=2.0
app.MapGet("/products", GetProducts)
   .HasApiVersion(2, 0);

Menjana Spesifikasi Berasingan bagi Setiap Versi

Konfigurasikan Swashbuckle untuk menjana dokumen OpenAPI berasingan bagi setiap versi supaya pengguna API hanya melihat titik akhir yang berkaitan dengan versi mereka.

builder.Services.AddSwaggerGen(opt =>
{
    opt.SwaggerDoc("v1", new() { Title = "API", Version = "v1" });
    opt.SwaggerDoc("v2", new() { Title = "API", Version = "v2" });
});

app.UseSwaggerUI(opt =>
{
    opt.SwaggerEndpoint("/swagger/v1/swagger.json", "v1");
    opt.SwaggerEndpoint("/swagger/v2/swagger.json", "v2");
});

Menerbitkan Binari Kendiri Sepenuhnya

Terbitkan API Minimal anda sebagai satu binari kendiri — tiada persekitaran masa jalan .NET diperlukan pada mesin sasaran.

# Publish for Linux x64 as self-contained
dotnet publish -c Release -r linux-x64 --self-contained true

# Run the output binary
./bin/Release/net9.0/linux-x64/publish/MyApi

# Optionally single-file:
# dotnet publish -c Release -r linux-x64 -p:PublishSingleFile=true

Membungkus dalam Kontena dengan Docker

Balut API dalam imej Docker menggunakan imej asas .NET rasmi. Dockerfile berbilang peringkat memastikan imej akhir kekal kecil.

# Dockerfile (multi-stage)
FROM mcr.microsoft.com/dotnet/sdk:9.0 AS build
WORKDIR /src
COPY . .
RUN dotnet publish -c Release -o /app

FROM mcr.microsoft.com/dotnet/aspnet:9.0
WORKDIR /app
COPY --from=build /app .
ENTRYPOINT ["dotnet", "MyApi.dll"]

# Build and run
# docker build -t my-api .
# docker run -p 8080:8080 my-api

Menyebarkan ke Azure App Service

Sebarkan terus ke Azure App Service daripada CLI. Perkhidmatan ini mengurus penskalaan, sijil dan domain tersuai.

# Publish to folder first
dotnet publish -c Release -o ./publish

# Deploy to Azure App Service
az webapp up \
  --name my-products-api \
  --resource-group myRG \
  --runtime DOTNETCORE:9.0 \
  --sku B1

# View logs
az webapp log tail --name my-products-api --resource-group myRG

Pemeriksaan Kesihatan

Tambahkan titik akhir pemeriksaan kesihatan supaya alat orkestrasi seperti Kubernetes dan Azure boleh mengesahkan bahawa API anda hidup dan sedia menerima trafik.

builder.Services.AddHealthChecks()
    .AddDbContextCheck<AppDbContext>()
    .AddUrlGroup(new Uri("https://api.external.com/ping"), "external");

app.MapHealthChecks("/health");
app.MapHealthChecks("/health/ready", new HealthCheckOptions
{
    Predicate = hc => hc.Tags.Contains("ready")
});

Senarai Semak Pengeluaran

API Minimal untuk pengeluaran sepatutnya merangkumi tetapan ini demi ketepatan, kebolehcerapan dan keselamatan.

// builder configuration
builder.Services.AddProblemDetails();
builder.Services.AddHealthChecks();
builder.Services.AddRateLimiter(...);
builder.Services.AddOutputCache();

// app pipeline
app.UseHttpsRedirection();
app.UseExceptionHandler();
app.UseRateLimiter();
app.UseOutputCache();
app.UseAuthentication();
app.UseAuthorization();

app.MapHealthChecks("/health");
// ... your endpoints
app.Run();

Semakan Ringkas

Kaedah manakah yang menjadikan metadata titik akhir (Produces, WithSummary dan sebagainya) kelihatan kepada perkakas OpenAPI dalam API Minimal?

Imbas Kembali: OpenAPI, Pemversian dan Penyebaran

Inti pati penting:

  • AddEndpointsApiExplorer + Swashbuckle = UI Swagger untuk API Minimal
  • Anotasikan dengan Produces, WithSummary dan WithTags untuk dokumentasi OpenAPI yang lengkap
  • Pemversian mudah melalui kumpulan laluan; Asp.Versioning untuk senario lanjutan
  • Terbitkan binari kendiri atau imej Docker untuk penyebaran yang fleksibel
  • Tambahkan pemeriksaan kesihatan untuk prob kesediaan Kubernetes/Azure
Percuma untuk bermula

Pelajari C# dengan tutor kecerdasan buatan — percuma

Tulis dan jalankan kod sebenar dalam pelayar anda, dapatkan bantuan segera daripada tutor kecerdasan buatan yang tersedia 24/7, dan sambung semula dari tempat anda berhenti di web atau dalam aplikasi.

Kursus
93
Pelajaran
346

Soalan Lazim

Adakah pelajaran “OpenAPI, Pemversian & Penggunaan” percuma?

Ya — teks penuh “OpenAPI, Pemversian & Penggunaan” boleh dibaca secara percuma di web ini. Untuk berlatih secara interaktif menggunakan penyunting kod terbina dalam dan tutor kecerdasan buatan 24/7, serta membuka kunci baki kursus Akademi C#, tingkat taraf kepada CoddyKit PRO. Kursus Akademi C# merangkumi sejumlah 4 pelajaran.

Apakah yang akan saya pelajari dalam “OpenAPI, Pemversian & Penggunaan”?

Jana dokumentasi Swagger/OpenAPI, versikan API dan gunakan API Minimal ke Azure App Service atau bekas. Anda berlatih Akademi C# menggunakan kod praktikal yang dijalankan terus dalam pelayar, manakala tutor kecerdasan buatan 24/7 menjawab soalan anda semasa anda mengikuti pelajaran.

Adakah saya memerlukan pengalaman untuk memulakan Akademi C#?

Tiada pengalaman terdahulu diperlukan. Pembelajaran Akademi C# di CoddyKit disusun untuk pelajar daripada peringkat pemula hingga lanjutan, jadi anda boleh bermula di sini atau dari awal dan belajar mengikut kadar anda sendiri. Ini ialah pelajaran 4 daripada 4.

Berapa lamakah pelajaran “OpenAPI, Pemversian & Penggunaan” diambil?

Kebanyakan pelajaran CoddyKit mengambil masa kira-kira 5–10 minit. Setiap pelajaran ringkas dan interaktif, jadi anda boleh membuat kemajuan secara berterusan dan menyambung tepat dari tempat anda berhenti di web atau aplikasi.

Bolehkah saya menulis dan menjalankan kod dalam pelajaran Akademi C# ini?

Ya. Setiap pelajaran Akademi C# menyertakan penyunting kod terbina dalam, jadi anda boleh menulis dan menjalankan kod sebenar terus dalam pelayar serta menerima maklum balas kecerdasan buatan serta-merta — tanpa memerlukan persediaan setempat.

Semua pelajaran dalam kursus ini

  1. Mencipta API Minimal Pertama Anda
  2. Kumpulan Laluan, Parameter & Pengesahan
  3. Perisian Tengah & Penapis dalam API Minimal
  4. OpenAPI, Pemversian & Penggunaan
← Kembali ke Akademi C#