ASP.NET Core ve MongoDB ile web API'si oluşturma

Tarafından Pratik Khandelwal ve Scott Addie

Bu öğretici, MongoDB NoSQL veritabanında Oluşturma, Okuma, Güncelleştirme ve Silme (CRUD) işlemlerini çalıştıran bir web API'sini oluşturur.

Bu öğreticide aşağıdakilerin nasıl yapılacağını öğreneceksiniz:

• MongoDB'yi yapılandırma
• MongoDB veritabanı oluşturma
• MongoDB koleksiyonu ve şeması tanımlama
• Web API'sinden MongoDB CRUD işlemleri gerçekleştirme
• JSON serileştirmeyi özelleştirme

Önkoşullar

• MongoDB 6.0.5 veya üzeri
• MongoDB Kabuğu

Visual Studio

• ASP.NET ve web geliştirme iş yüküyle Visual Studio 2022.

  

Visual Studio Code

• Visual Studio Code
• Visual Studio Code için C# Geliştirme Seti
• .NET 9 SDK

macOS, Linux veya Windows'da Visual Studio Code yönergelerini izleyebilirsiniz. Visual Studio Code dışında bir tümleşik geliştirme ortamı (IDE) kullanıyorsanız değişiklikler gerekebilir.

MongoDB'yi yapılandırma

Geliştirme makinesinde (Windows/Linux/macOS) her yerden MongoDB ve MongoDB Kabuğu erişimini etkinleştirin:

1. MongoDB Kabuğunu İndirme ve Yükleme:

   • macOS/Linux: MongoDB Kabuğunu ayıklamak için bir dizin seçin. ortam değişkenine mongosh için PATH sonuç yolunu ekleyin.
   • Windows: MongoDB Kabuğu (mongosh.exe), C:\Users\user<\>AppData\Local\Programs\mongosh konumunda yüklenir. ortam değişkenine mongosh.exe için PATH sonuç yolunu ekleyin.

2. MongoDB'yi indirin ve yükleyin:

   • macOS/Linux: Genellikle /usr/local/mongodb içinde MongoDB'nin yüklendiği dizini doğrulayın. ortam değişkenine mongodb için PATH sonuç yolunu ekleyin.
   • Windows: MongoDB varsayılan olarak C:\Program Files\MongoDB konumunda yüklenir. Ortam değişkenine < C:\Program Files\MongoDB\Server\>version_number\binPATH.

3. Veri Depolama Dizini seçin: Verileri depolamak için geliştirme makinenizde bir dizin seçin. Yoksa dizini oluşturun. MongoDB Kabuğu yeni dizinler oluşturmaz:

   • macOS/Linux: Örneğin, /usr/local/var/mongodb.
   • Windows: Örneğin, C:\\BooksData.

4. İşletim sistemi komut kabuğunda (MongoDB Kabuğu değil), varsayılan bağlantı noktası 27017'de MongoDB'ye bağlanmak için aşağıdaki komutu kullanın. <data_directory_path> değerini önceki adımda seçilen dizinle değiştirin.

   mongod --dbpath <data_directory_path>
   

Veritabanı oluşturmak, koleksiyonlar yapmak ve belgeleri depolamak için aşağıdaki adımlarda daha önce yüklenmiş mongoDB kabuğunu kullanın. MongoDB Kabuğu komutları hakkında daha fazla bilgi için bkz mongosh.

1. komutunu başlatarak mongosh.exeveya komut kabuğunda aşağıdaki komutu çalıştırarak bir MongoDB komut kabuğu örneği açın:

   mongosh
   

2. Komut kabuğunda şu komutu çalıştırarak varsayılan test veritabanına bağlanın:

   use BookStore
   

   BookStore adlı bir veritabanı henüz yoksa oluşturulur. Veritabanı mevcutsa, işlemler için bağlantısı açılır.

3. Aşağıdaki komutu kullanarak koleksiyon Books oluşturun:

   db.createCollection('Books')
   

   Aşağıdaki sonuç görüntülenir:

   { "ok" : 1 }
   

4. Koleksiyon için Books bir şema tanımlayın ve aşağıdaki komutu kullanarak iki belge ekleyin:

   db.Books.insertMany([{ "Name": "Design Patterns", "Price": 54.93, "Category": "Computers", "Author": "Ralph Johnson" }, { "Name": "Clean Code", "Price": 43.15, "Category": "Computers","Author": "Robert C. Martin" }])
   

   Aşağıdakine benzer bir sonuç görüntülenir:

   {
       "acknowledged" : true,
       "insertedIds" : [
           ObjectId("61a6058e6c43f32854e51f51"),
           ObjectId("61a6058e6c43f32854e51f52")
        ]
    }
   

   Not

   ObjectIdÖnceki sonuçta gösterilenler, komut kabuğunda gösterilenlerle eşleşmez.

5. Aşağıdaki komutu kullanarak veritabanındaki belgeleri görüntüleyin:

   db.Books.find().pretty()
   

   Aşağıdakine benzer bir sonuç görüntülenir:

   {
        "_id" : ObjectId("61a6058e6c43f32854e51f51"),
        "Name" : "Design Patterns",
        "Price" : 54.93,
        "Category" : "Computers",
        "Author" : "Ralph Johnson"
    }
    {
        "_id" : ObjectId("61a6058e6c43f32854e51f52"),
        "Name" : "Clean Code",
        "Price" : 43.15,
        "Category" : "Computers",
        "Author" : "Robert C. Martin"
    }
   

   Şema, her belge için otomatik olarak oluşturulan türü _id bir ObjectId özelliği ekler.

ASP.NET Core web API projesini oluşturma

Visual Studio

1. Dosya gidin.
2. ASP.NET Core Web API proje türünü seçin ve İleri'yi seçin.
3. Projeye BookStoreApi adını verin ve İleri'yi seçin.
4. Ek bilgi iletişim kutusunda:

• Çerçevenin.NET 9.0 (Standart Terim Desteği) olduğunu onaylayın.
• Denetleyicileri kullan onay kutusunun işaretli olduğunu onaylayın.
• OpenAPI desteğini etkinleştir onay kutusunun işaretli olduğunu onaylayın.
• Oluştur'u seçin.

1. Paket Yöneticisi Konsolu penceresinde proje köküne gidin. MongoDB için .NET sürücüsünü yüklemek için aşağıdaki komutu çalıştırın:

   Install-Package MongoDB.Driver
   

Visual Studio Code

1. Komut kabuğunda aşağıdaki komutları çalıştırın:

   dotnet new webapi -o BookStoreApi --use-controllers
   code BookStoreApi
   

   Yukarıdaki komutlar yeni bir ASP.NET Core web API'si projesi oluşturur ve projeyi Visual Studio Code'da açar.

2. OmniSharp sunucusu başlatıldıktan sonra, 'BookStoreApi' içinde Derlemek ve hata ayıklamak için gerekli varlıklar eksik. Eklensin mi? şeklinde bir iletişim kutusu belirir. Evet'i seçin.

3. Tümleşik Terminal'i açın ve MongoDB için .NET sürücüsünü yüklemek için aşağıdaki komutu çalıştırın:

   dotnet add package MongoDB.Driver
   

Varlık modeli ekleme

1. Proje köküne models dizini ekleyin.

2. Book dizinine aşağıdaki kodla bir sınıf ekleyin:

   using MongoDB.Bson;
   using MongoDB.Bson.Serialization.Attributes;
   
   namespace BookStoreApi.Models;
   
   public class Book
   {
       [BsonId]
       [BsonRepresentation(BsonType.ObjectId)]
       public string? Id { get; set; }
   
       [BsonElement("Name")]
       public string BookName { get; set; } = null!;
   
       public decimal Price { get; set; }
   
       public string Category { get; set; } = null!;
   
       public string Author { get; set; } = null!;
   }
   

   Önceki sınıfta Id özelliği şöyledir:

   • Ortak Dil Çalışma Zamanı (CLR) nesnesini MongoDB koleksiyonuna eşlemek için gereklidir.
   • Bu özelliği belgenin birincil anahtarı yapmak için [BsonId] ile anotasyon yapıldı.
   • parametresinin ObjectId[BsonRepresentation(BsonType.ObjectId)]yapısı yerine tür string olarak geçirilmesine izin vermek için ile ek açıklama eklenir. Mongo, 'den string öğesine dönüştürmeyi ObjectIdişler.

   BookName özelliğine özniteliğiyle [BsonElement] ek açıklama eklenir. özniteliğinin değeri Name MongoDB koleksiyonundaki özellik adını temsil eder.

Yapılandırma modeli ekleme

1. aşağıdaki veritabanı yapılandırma değerlerini içine appsettings.jsonekleyin:

   {
     "BookStoreDatabase": {
       "ConnectionString": "mongodb://localhost:27017",
       "DatabaseName": "BookStore",
       "BooksCollectionName": "Books"
     },
     "Logging": {
       "LogLevel": {
         "Default": "Information",
         "Microsoft.AspNetCore": "Warning"
       }
     },
     "AllowedHosts": "*"
   }
   

2. BookStoreDatabaseSettings dizinine aşağıdaki kodla bir sınıf ekleyin:

   namespace BookStoreApi.Models;
   
   public class BookStoreDatabaseSettings
   {
       public string ConnectionString { get; set; } = null!;
   
       public string DatabaseName { get; set; } = null!;
   
       public string BooksCollectionName { get; set; } = null!;
   }
   

   Önceki BookStoreDatabaseSettings sınıf, dosyanın appsettings.json özellik değerlerini depolamak BookStoreDatabase için kullanılır. Eşleme işlemini kolaylaştırmak için JSON ve C# özellik adları aynı şekilde adlandırılır.

3. aşağıdaki vurgulanmış kodu içine Program.csekleyin:

   var builder = WebApplication.CreateBuilder(args);
   
   // Add services to the container.
   builder.Services.Configure<BookStoreDatabaseSettings>(
       builder.Configuration.GetSection("BookStoreDatabase"));
   

   Yukarıdaki kodda, dosyanın appsettings.json bölümünün bağlandığı BookStoreDatabase yapılandırma örneği Bağımlılık Ekleme (DI) kapsayıcısına kaydedilir. Örneğin, nesnesinin BookStoreDatabaseSettingsConnectionString özelliği içindeki BookStoreDatabase:ConnectionStringözelliğiyle appsettings.json doldurulur.

4. Program.cs üst kısmına şu kodu ekleyerek BookStoreDatabaseSettings referansını çözün:

   using BookStoreApi.Models;
   

CRUD işlem hizmeti ekleme

1. Proje köküne bir Services dizini ekleyin.

2. Services dizinine aşağıdaki kodla bir BooksService sınıf ekleyin:

   using BookStoreApi.Models;
   using Microsoft.Extensions.Options;
   using MongoDB.Driver;
   
   namespace BookStoreApi.Services;
   
   public class BooksService
   {
       private readonly IMongoCollection<Book> _booksCollection;
   
       public BooksService(
           IOptions<BookStoreDatabaseSettings> bookStoreDatabaseSettings)
       {
           var mongoClient = new MongoClient(
               bookStoreDatabaseSettings.Value.ConnectionString);
   
           var mongoDatabase = mongoClient.GetDatabase(
               bookStoreDatabaseSettings.Value.DatabaseName);
   
           _booksCollection = mongoDatabase.GetCollection<Book>(
               bookStoreDatabaseSettings.Value.BooksCollectionName);
       }
   
       public async Task<List<Book>> GetAsync() =>
           await _booksCollection.Find(_ => true).ToListAsync();
   
       public async Task<Book?> GetAsync(string id) =>
           await _booksCollection.Find(x => x.Id == id).FirstOrDefaultAsync();
   
       public async Task CreateAsync(Book newBook) =>
           await _booksCollection.InsertOneAsync(newBook);
   
       public async Task UpdateAsync(string id, Book updatedBook) =>
           await _booksCollection.ReplaceOneAsync(x => x.Id == id, updatedBook);
   
       public async Task RemoveAsync(string id) =>
           await _booksCollection.DeleteOneAsync(x => x.Id == id);
   }
   

   Önceki kodda, bir BookStoreDatabaseSettings örneği oluşturucu enjeksiyonu yoluyla DI'den alınır. Bu teknik, Yapılandırma appsettings.json bölümünde eklenen yapılandırma değerlerine erişim sağlar.

3. aşağıdaki vurgulanmış kodu içine Program.csekleyin:

   var builder = WebApplication.CreateBuilder(args);
   
   // Add services to the container.
   builder.Services.Configure<BookStoreDatabaseSettings>(
       builder.Configuration.GetSection("BookStoreDatabase"));
   
   builder.Services.AddSingleton<BooksService>();
   

   Yukarıdaki kodda BooksService sınıfı, kullanan sınıflarda oluşturucu eklemeyi desteklemek için DI ile kaydedilir. Tekil hizmet ömrü en uygun olandır çünkü BooksService, MongoClient üzerinde doğrudan bağımlıdır. Resmi Mongo İstemcisi yeniden kullanım yönergeleri uyarınca, MongoClient tekil hizmet ömrüyle DI'ye kaydedilmelidir.

4. Program.cs üst kısmına şu kodu ekleyerek BooksService referansını çözün:

   using BookStoreApi.Services;
   

sınıfı, BooksService veritabanında CRUD işlemlerini çalıştırmak için aşağıdaki MongoDB.Driver üyeleri kullanır:

• MongoClient: Veritabanı işlemlerini çalıştırmak için sunucu örneğini okur. Bu sınıfın oluşturucusu, MongoDB bağlantı dizesi içinde bulunur.

  public BooksService(
      IOptions<BookStoreDatabaseSettings> bookStoreDatabaseSettings)
  {
      var mongoClient = new MongoClient(
          bookStoreDatabaseSettings.Value.ConnectionString);
  
      var mongoDatabase = mongoClient.GetDatabase(
          bookStoreDatabaseSettings.Value.DatabaseName);
  
      _booksCollection = mongoDatabase.GetCollection<Book>(
          bookStoreDatabaseSettings.Value.BooksCollectionName);
  }
  

• IMongoDatabase: çalıştırma işlemleri için Mongo veritabanını temsil eder. Bu öğreticide, belirli bir koleksiyondaki verilere erişim elde etmek için arabirimdeki genel GetCollection<TDocument>(koleksiyon) yöntemi kullanılır. Bu yöntem çağrıldıktan sonra koleksiyona karşı CRUD işlemlerini çalıştırın. GetCollection<TDocument>(collection) yöntem çağrısında:

  • collection koleksiyon adını temsil eder.
  • TDocument koleksiyonda depolanan CLR nesne türünü temsil eder.

GetCollection<TDocument>(collection) , koleksiyonu temsil eden bir MongoCollection nesnesi döndürür. Bu öğreticide, koleksiyondaki yöntemler aşağıdaki şekilde çağrılacak:

• DeleteOneAsync: Sağlanan arama ölçütleriyle eşleşen tek bir belgeyi siler.
• Bulmak<TDocument>: Koleksiyondaki sağlanan arama ölçütleriyle eşleşen tüm belgeleri döndürür.
• InsertOneAsync: Sağlanan nesneyi koleksiyona yeni bir belge olarak ekler.
• ReplaceOneAsync: Sağlanan arama ölçütleriyle eşleşen tek belgeyi sağlanan nesneyle değiştirir.

Denetleyici ekleme

BooksController dizinine aşağıdaki kodla bir sınıf ekleyin:

using BookStoreApi.Models;
using BookStoreApi.Services;
using Microsoft.AspNetCore.Mvc;

namespace BookStoreApi.Controllers;

[ApiController]
[Route("api/[controller]")]
public class BooksController : ControllerBase
{
    private readonly BooksService _booksService;

    public BooksController(BooksService booksService) =>
        _booksService = booksService;

    [HttpGet]
    public async Task<List<Book>> Get() =>
        await _booksService.GetAsync();

    [HttpGet("{id:length(24)}")]
    public async Task<ActionResult<Book>> Get(string id)
    {
        var book = await _booksService.GetAsync(id);

        if (book is null)
        {
            return NotFound();
        }

        return book;
    }

    [HttpPost]
    public async Task<IActionResult> Post(Book newBook)
    {
        await _booksService.CreateAsync(newBook);

        return CreatedAtAction(nameof(Get), new { id = newBook.Id }, newBook);
    }

    [HttpPut("{id:length(24)}")]
    public async Task<IActionResult> Update(string id, Book updatedBook)
    {
        var book = await _booksService.GetAsync(id);

        if (book is null)
        {
            return NotFound();
        }

        updatedBook.Id = book.Id;

        await _booksService.UpdateAsync(id, updatedBook);

        return NoContent();
    }

    [HttpDelete("{id:length(24)}")]
    public async Task<IActionResult> Delete(string id)
    {
        var book = await _booksService.GetAsync(id);

        if (book is null)
        {
            return NotFound();
        }

        await _booksService.RemoveAsync(id);

        return NoContent();
    }
}

Önceki web API'si denetleyicisi:

• CRUD işlemlerini çalıştırmak için sınıfını BooksService kullanır.
• GET, POST, PUT ve DELETE HTTP isteklerini desteklemek için eylem yöntemleri içerir.
• CreatedAtAction Create yanıtı döndürmek için eylem yönteminde çağrılar. Durum kodu 201, sunucuda yeni bir kaynak oluşturan bir HTTP POST yöntemi için standart yanıttır. CreatedAtAction ayrıca yanıta bir Location üst bilgi ekler. Başlık, Location yeni oluşturulan kitabın URI'sini belirtir.

JSON serileştirme seçeneklerini yapılandırma

Web API'sini test etme bölümünde döndürülen JSON yanıtları hakkında değiştirecek iki ayrıntı vardır:

• Özellik adlarının varsayılan deve sırtı yazımı, CLR nesnesinin özellik adlarının Pascal durumuyla eşleşecek şekilde değiştirilmelidir.
• bookName özelliği Name olarak döndürülmelidir.

Önceki gereksinimleri karşılamak için aşağıdaki değişiklikleri yapın:

1. Program.cs içinde, aşağıdaki vurgulanmış kodu AddControllers yöntemi çağrısına zincirleyin.

   var builder = WebApplication.CreateBuilder(args);
   
   // Add services to the container.
   builder.Services.Configure<BookStoreDatabaseSettings>(
       builder.Configuration.GetSection("BookStoreDatabase"));
   
   builder.Services.AddSingleton<BooksService>();
   
   builder.Services.AddControllers()
       .AddJsonOptions(
           options => options.JsonSerializerOptions.PropertyNamingPolicy = null);
   

   Yukarıdaki değişiklikle, web API'sinin serileştirilmiş JSON yanıtlarındaki özellik adları CLR nesne türündeki ilgili özellik adlarıyla eşleşmektedir. Örneğin, Book sınıfının Author özelliği, Author yerine author olarak serileştirilir.

2. Models/Book.cs içinde, BookName özelliğine [JsonPropertyName] özniteliği ekleyin.

   [BsonElement("Name")]
   [JsonPropertyName("Name")]
   public string BookName { get; set; } = null!;
   

   [JsonPropertyName] özniteliğinin değeriName, web API'sinin serileştirilmiş JSON yanıtında özellik adını temsil eder.

3. Models/Book.cs'nın üst kısmına aşağıdaki kodu ekleyin [JsonProperty] öznitelik başvurusunu çözmek için:

   using System.Text.Json.Serialization;
   

4. Web API'sini test et bölümünde tanımlanan adımları yineleyin. JSON özellik adlarındaki farka dikkat edin.

Web API'sini test edin

Visual Studio

Bu öğreticide API'yi test etmek için Uç Nokta Gezgini ve .http dosyaları kullanılır.

1. Uygulamayı derleyin ve çalıştırın.

2. Uç Nokta Gezgini'nde, ilk GET uç noktasına /api/bookssağ tıklayın ve İstek oluştur'a tıklayın.

   Dosyaya BookStoreApi.http aşağıdaki içerik eklenir. İlk kez istek oluşturulduysa, dosya proje kökünde oluşturulur.

   @BookStoreApi_HostAddress = https://localhost:<port>
   
   GET {{BookStoreApi_HostAddress}}/api/books
   
   ###
   

   Bağlantı noktası numarası, uygulama tarafından kullanılan bağlantı noktasına ayarlanmış olmalıdır; örneğin, https://localhost:56874. Böyle bir durum söz konusu değilse, uygulamayı başlattığınızda çıkış penceresinde bağlantı noktası numaranızı bulabilirsiniz.

3. Yeni istek satırının üzerindeki GET bağlantısını seçin.

   GET isteği uygulamaya gönderilir ve yanıt Yanıt bölmesinde görüntülenir.

4. Yanıt gövdesi, aşağıdakine benzer kitap girişlerini içeren JSON sonucunu gösterir:

   [
     {
       "Id": "61a6058e6c43f32854e51f51",
       "Name": "Design Patterns",
       "Price": 54.93,
       "Category": "Computers",
       "Author": "Ralph Johnson"
     },
     {
       "Id": "61a6058e6c43f32854e51f52",
       "Name": "Clean Code",
       "Price": 43.15,
       "Category": "Computers",
       "Author": "Robert C. Martin"
     }
   ]
   

5. Tek bir kitap almak için /api/books/{id}, params (string id)GET uç noktasına sağ tıklayın ve İstek oluştur'a tıklayın.

   Dosyanın sonuna BookStoreApi.http aşağıdaki içerik eklenir:

   @id=string
   GET {{BookStoreApi_HostAddress}}/api/books/{{id}}
   
   ###
   

6. id değişkenini, önceki istekten döndürülen kimliklerden biriyle değiştirin. Örneğin:

   @id="61a6058e6c43f32854e51f52"
   GET {{BookStoreApi_HostAddress}}/api/books/{{id}}
   
   ###
   

7. Yeni istek satırının üzerindeki GET bağlantısını seçin.

   GET isteği uygulamaya gönderilir ve yanıt Yanıt bölmesinde görüntülenir.

8. Yanıt gövdesi JSON'ı aşağıdakine benzer şekilde gösterir:

   {
     "Id": "61a6058e6c43f32854e51f52",
     "Name": "Clean Code",
     "Price": 43.15,
     "Category": "Computers",
     "Author": "Robert C. Martin"
   }
   

9. POST uç noktasını test etmek için /api/books uç noktasına sağ tıklayın ve İstek oluştur'a tıklayın.

   Dosyaya BookStoreApi.http aşağıdaki içerik eklenir:

   POST {{BookStoreApi_HostAddress}}/api/books
   Content-Type: application/json
   
   {
     //Book
   }
   
   ###
   

10. Kitap açıklamasını JSON istek gövdesi olarak bir kitap nesnesiyle değiştirin:

    POST {{BookStoreApi_HostAddress}}/api/books
    Content-Type: application/json
    
     {
       "Name": "The Pragmatic Programmer",
       "Price": 49.99,
       "Category": "Computers",
       "Author": "Andy Hunt"
     }
    
    ###
    

11. İstek satırının üstündeki POST bağlantısını seçin.

    POST isteği uygulamaya gönderilir ve yanıt Yanıt bölmesinde görüntülenir. Yanıt, atanan kimliğiyle yeni oluşturulan kitabı içermelidir.

12. Son olarak, bir kitabı silmek için /api/books/{id}, params (string id) uç noktasına sağ tıklayın ve İstek oluştur'a tıklayın.

    Dosyanın sonuna BookStoreApi.http aşağıdaki içerik eklenir:

    DELETE {{BookStoreApi_HostAddress}}/api/Books/{{id}}
    
    ###
    

13. değişkenini id önceki istekten döndürülen kimliklerden biriyle değiştirin ve İstek gönder'e tıklayın. Örneğin:

    DELETE {{BookStoreApi_HostAddress}}/api/Books/67f417517ce1b36aeab71236
    
    ###
    

Visual Studio Code

Bu öğreticide, API'yi test etmek için OpenAPI belirtimi (openapi.json) ve Swagger kullanıcı arabirimi kullanılır.

1. Aşağıdaki komutu çalıştırarak Swagger kullanıcı arabirimini yükleyin:

dotnet add package NSwag.AspNetCore

Önceki komut, Swagger belgeleri ve kullanıcı arabirimi oluşturmaya yönelik araçlar içeren NSwag.AspNetCore paketini ekler. Projemiz OpenAPI kullandığından, Swagger kullanıcı arabirimini oluşturmak için yalnızca NSwag paketini kullanırız.

1. Swagger ara yazılımını yapılandırma

Program.csiçinde aşağıdaki vurgulanmış kodu ekleyin:

var app = builder.Build();

if (app.Environment.IsDevelopment())
{
    app.MapOpenApi();
    app.UseSwaggerUI(options =>
    {
        options.SwaggerEndpoint("/openapi/v1.json", "v1");
    });
}

Önceki kod, Swagger ara yazılımının Swagger kullanıcı arabirimini kullanarak oluşturulan JSON belgesini sunmasını sağlar. Swagger yalnızca geliştirme ortamında etkinleştirilir. Bir üretim ortamında Swagger'ın etkinleştirilmesi, API'nin yapısı ve uygulaması hakkında hassas olabilecek ayrıntıları ortaya çıkarabilir.

Uygulama, kullanıcı arabirimini oluşturmak için /openapi/v1.jsonkonumunda bulunan OpenApi tarafından oluşturulan OpenAPI belgesini kullanır. Tarayıcınızda WeatherForecast adresine giderek, proje çalışırken https://localhost:<port>/openapi/v1.json API'si için oluşturulan OpenAPI belirtimini görüntüleyin.

OpenAPI belirtimi, uç noktalar, istek/yanıt biçimleri, parametreler ve daha fazlası dahil olmak üzere API'nizin yapısını ve özelliklerini açıklayan JSON biçiminde bir belgedir. Temelde API'nizi anlamak ve api'nizle etkileşime geçmek için çeşitli araçlar tarafından kullanılabilecek bir API şemasıdır.

1. Uygulamayı derleyin ve çalıştırın.

2. Tarayıcınızda https://localhost:<port>/swagger adresine gidin. Swagger, OpenAPI belgesine göre tüm API uç noktalarını test etmek için bir kullanıcı arabirimi sağlar.

3. GET /api/books uç noktasını genişletin ve Deneyin düğmesine tıklayın.

4. İsteği API'ye göndermek için Yürüt düğmesine tıklayın.

5. Yanıt gövdesi bölümünde aşağıdakine benzer kitaplar içeren bir JSON dizisi görüntülenir:

   [
     {
       "Id": "61a6058e6c43f32854e51f51",
       "Name": "Design Patterns",
       "Price": 54.93,
       "Category": "Computers",
       "Author": "Ralph Johnson"
     },
     {
       "Id": "61a6058e6c43f32854e51f52",
       "Name": "Clean Code",
       "Price": 43.15,
       "Category": "Computers",
       "Author": "Robert C. Martin"
     }
   ]
   

6. Ardından GET /api/books/{id} uç noktasını genişletin ve Deneyin'e tıklayın.

7. Kimlik alanına önceki yanıttaki kitap kimliklerinden birini girin ve Yürüt'e tıklayın.

8. Yanıt gövdesi bölümü, belirtilen kitap için JSON nesnesini görüntüler. Örneğin, kimlik 61a6058e6c43f32854e51f52 için sonuç aşağıdakine benzer:

   {
     "Id": "61a6058e6c43f32854e51f52",
     "Name": "Clean Code",
     "Price": 43.15,
     "Category": "Computers",
     "Author": "Robert C. Martin"
   }
   

9. Yeni kitap oluşturmayı test etmek için POST /api/books uç noktasını genişletin ve Deneyin'e tıklayın.

10. Varsayılan istek gövdesini yeni bir kitap nesnesiyle değiştirin:

    {
      "Name": "The Pragmatic Programmer",
      "Price": 49.99,
      "Category": "Computers",
      "Author": "Andy Hunt"
    }
    

11. İsteği göndermek için Yürüt'e tıklayın.

12. Yanıt 201 (Oluşturuldu) durum koduna sahip olmalı ve yeni oluşturulan kitabı yanıt gövdesine atanan kimliğiyle birlikte eklemelidir.

13. Son olarak, bir kitap kaydını silmek için DELETE /api/books/{id} uç noktasını genişletin, Deneyin'e tıklayın ve kimlik alanına önceki yanıttaki kitap kimliklerinden birini girin. İsteği göndermek için Yürüt'e tıklayın.

14. Yanıtta, kitabın başarıyla silindiğini belirten 204 (İçerik Yok) durum kodu olmalıdır.

Web API'sine kimlik doğrulaması desteği ekleme

ASP.NET Core Identity , ASP.NET Core web uygulamalarına kullanıcı arabirimi (UI) oturum açma işlevi ekler. Web API'lerinin ve SPA'larının güvenliğini sağlamak için aşağıdakilerden birini kullanın:

• Microsoft Entra ID
• Azure Active Directory B2C (Azure AD B2C)
• Duende Identity Sunucusu

Duende Identity Server, ASP.NET Core için bir OpenID Connect ve OAuth 2.0 çerçevesidir. Duende Identity Sunucusu aşağıdaki güvenlik özelliklerini etkinleştirir:

• Hizmet Olarak Kimlik Doğrulaması (AaaS)
• Birden çok uygulama türü üzerinde çoklu oturum açma/kapatma (SSO)
• API'ler için erişim denetimi
• Federasyon Ağ Geçidi

Önemli

Duende Software, DuendeIdentity Server'ın üretim kullanımı için lisans ücreti ödemenizi gerektirebilir. Daha fazla bilgi için bkz. .NET 5'te ASP.NET Core'dan .NET 6'ya geçiş.

Daha fazla bilgi için Duende Server belgelerine Identity bakın.

Ek kaynaklar

• Örnek kodu görüntüleme veya indirme (indirme)
• ASP.NET Core ile web API'leri oluşturma
• ASP.NET Core web API'sinde denetleyici eylemi dönüş türleri
• ASP.NET Core ile web API'si oluşturma