Creación de una API Web con ASP.NET Core y MongoDB

Por Pratik Khandelwal y Scott Addie

En este tutorial se crea una API web que ejecuta operaciones de creación, lectura, actualización y eliminación (CRUD) en una base de datos NoSQL de MongoDB.

En este tutorial aprenderá a:

• Configuración de MongoDB
• Crear una base de datos de MongoDB
• Definir un esquema y una colección de MongoDB
• Realizar operaciones de CRUD de MongoDB desde una API web
• Personalizar la serialización de JSON

Prerequisites

• MongoDB 6.0.5 o posterior
• MongoDB Shell

Visual Studio

• Visual Studio 2022 con la carga de trabajo de ASP.NET y desarrollo web

  

Visual Studio Code

• Visual Studio Code
• Kit de desarrollo de C# para Visual Studio Code
• SDK de .NET 9

Puede seguir las instrucciones de Visual Studio Code en macOS, Linux o Windows. Es posible que se requieran cambios si usa un entorno de desarrollo integrado (IDE) distinto de Visual Studio Code.

Configuración de MongoDB

Habilite el acceso a MongoDB y al shell de MongoDB desde cualquier lugar en el equipo de desarrollo (Windows/Linux/macOS):

1. Descargue e instale el shell de MongoDB:

   • macOS/Linux: elija un directorio para extraer el shell de MongoDB. Agregue la ruta de acceso resultante para mongosh a la variable de entorno PATH.
   • Windows: El shell de MongoDB (mongosh.exe) se instala en C:\Users\<user>\AppData\Local\Programs\mongosh. Agregue la ruta de acceso resultante para mongosh.exe a la variable de entorno PATH.

2. Descargue e instale MongoDB:

   • macOS/Linux: compruebe el directorio en el que se instaló MongoDB, normalmente en /usr/local/mongodb. Agregue la ruta de acceso resultante para mongodb a la variable de entorno PATH.
   • Windows: MongoDB está instalado en C:\Archivos de programa\MongoDB de forma predeterminada. Agregue C:\Archivos de programa\MongoDB\Server<número_versión>\bin a la variable de entorno PATH.

3. Elija un directorio de almacenamiento de datos: seleccione un directorio en el equipo de desarrollo para almacenar los datos. Si no existe el directorio, créelo. El shell de MongoDB no crea nuevos directorios:

   • macOS/Linux: por ejemplo, /usr/local/var/mongodb.
   • Windows: por ejemplo, C:\\BooksData.

4. En el shell de comandos del sistema operativo (no en el shell de MongoDB), use el siguiente comando para conectarse a MongoDB en el puerto predeterminado 27017. Reemplace <data_directory_path> por el directorio elegido en el paso anterior.

   mongod --dbpath <data_directory_path>
   

Use el shell de MongoDB instalado previamente en los pasos siguientes para crear una base de datos, hacer colecciones y almacenar documentos. Para más información sobre los comandos de shell de MongoDB, vea mongosh.

1. Abra una instancia del shell de comandos de MongoDB iniciando mongosh.exeo ejecutando el siguiente comando en el shell de comandos:

   mongosh
   

2. En el shell de comandos, conéctese a la base de datos de prueba predeterminada mediante la ejecución de:

   use BookStore
   

   Se crea una base de datos denominada BookStore si aún no existe. Si la base de datos existe, su conexión se abre para las transacciones.

3. Cree una colección Books con el comando siguiente:

   db.createCollection('Books')
   

   Se muestra el siguiente resultado:

   { "ok" : 1 }
   

4. Defina un esquema para la colección Books e inserte dos documentos con el comando siguiente:

   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" }])
   

   Se muestra un resultado similar al siguiente:

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

   Note

   Los objetos ObjectId que se muestran en el resultado anterior no coincidirán con los que se muestran en el shell de comandos.

5. Vea los documentos en la base de datos mediante el comando siguiente:

   db.Books.find().pretty()
   

   Se muestra un resultado similar al siguiente:

   {
        "_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"
    }
   

   El esquema agrega una propiedad _id generada automáticamente del tipo ObjectId para cada documento.

Creación de un proyecto de API web de ASP.NET Core

Visual Studio

1. Vaya a Archivo>Nuevo>Proyecto.
2. Seleccione el tipo de proyecto API web de ASP.NET Core y, luego, Siguiente.
3. Denomine el proyecto BookStoreApi y seleccione Siguiente.
4. En el cuadro de diálogo Información adicional:

• Confirme que el Marco es .NET 9.0 (Soporte en un plazo estándar).
• Confirme que la casilla Usar controladores está activada.
• Confirme que la casilla Habilitar compatibilidad con OpenAPI está activada.
• Selecciona Crear.

1. En la ventana Consola del Administrador de paquetes, desplácese hasta la raíz del proyecto. Ejecute el siguiente comando para instalar el controlador .NET para MongoDB:

   Install-Package MongoDB.Driver
   

Visual Studio Code

1. Ejecute los siguientes comandos en un shell de comandos:

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

   Los comandos anteriores generan un nuevo proyecto de API web de ASP.NET Core y, a continuación, abren el proyecto en Visual Studio Code.

2. Una vez que se inicia el servidor OmniSharp, aparece un cuadro de diálogo con el texto Faltan los recursos necesarios para compilar y depurar desde "BookStoreApi", por si quiere agregarlos. Seleccione Sí.

3. Abra el Terminal integrado y ejecute el siguiente comando para instalar el controlador .NET para MongoDB:

   dotnet add package MongoDB.Driver
   

Adición de un modelo de entidad

1. Agregue un directorio Modelos a la raíz del proyecto.

2. Agregue una clase Book al directorio Models con el código siguiente:

   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!;
   }
   

   En la clase anterior, se requiere la propiedad Id:

   • para asignar el objeto de Common Language Runtime (CLR) a la colección de MongoDB.
   • para anotarla con [BsonId] a fin de designarla como clave principal del documento.
   • Anotado con [BsonRepresentation(BsonType.ObjectId)] para permitir el paso del parámetro como tipo string en lugar de una estructura ObjectId. Mongo controla la conversión de string a ObjectId.

   La propiedad BookName se anota con el atributo [BsonElement]. El valor Name del atributo representa el nombre de propiedad en la colección de MongoDB.

Agregar un modelo de configuración

1. Agregue los siguientes valores de configuración de base de datos a appsettings.json :

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

2. Agregue una clase BookStoreDatabaseSettings al directorio Models con el código siguiente:

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

   La clase anterior BookStoreDatabaseSettings se utiliza para almacenar los valores de propiedad appsettings.json del archivo BookStoreDatabase . Los nombres de las propiedades de JSON y C# son nombrados idénticamente para facilitar la correspondencia.

3. Agregue el código resaltado siguiente a Program.cs:

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

   En el código anterior, la instancia de configuración a la que la sección appsettings.json del archivo BookStoreDatabase enlaza está registrada en el contenedor de inserción de dependencias (DI). Por ejemplo, una propiedad BookStoreDatabaseSettings del objeto ConnectionString se rellena con la propiedad BookStoreDatabase:ConnectionString en appsettings.json.

4. Agregue el código siguiente en la parte superior del archivo Program.cs para resolver la referencia a BookStoreDatabaseSettings:

   using BookStoreApi.Models;
   

Adición de un servicio de operaciones CRUD

1. Agregue un directorio Servicios a la raíz del proyecto.

2. Agregue una clase BooksService al directorio Servicios con el código siguiente:

   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);
   }
   

   En el código anterior, se recuperó una instancia de BookStoreDatabaseSettings de la inserción de dependencias mediante la inserción de un constructor. Esta técnica proporciona acceso a los valores de configuración de appsettings.json que se agregaron en la sección Agregar un modelo de configuración.

3. Agregue el código resaltado siguiente a Program.cs:

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

   En el código anterior, la clase BooksService se registra con inserción de dependencias para admitir la inserción del constructor en las clases de consumo. El tiempo de vida del servicio tipo singleton es el más apropiado porque BooksService tiene una dependencia directa de MongoClient. Según las instrucciones oficiales de reutilización de cliente Mongo, MongoClient debe registrarse en la inserción de dependencias con una duración de servicio de tipo singleton.

4. Agregue el código siguiente en la parte superior del archivo Program.cs para resolver la referencia a BooksService:

   using BookStoreApi.Services;
   

La clase BooksService usa los miembros MongoDB.Driver siguientes para ejecutar operaciones CRUD en la base de datos:

• MongoClient: lee la instancia del servidor para ejecutar operaciones de base de datos. El constructor de esta clase se proporciona en la cadena de conexión de MongoDB.

  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: representa la base de datos de Mongo para ejecutar operaciones. Este tutorial usa el método genérico GetCollection<TDocument>(collection) en la interfaz para tener acceso a los datos de una colección específica. Ejecute las operaciones CRUD en la colección después de llamar a este método. En la llamada al método GetCollection<TDocument>(collection):

  • collection representa el nombre de la colección.
  • TDocument representa el tipo de objeto CLR almacenado en la colección.

GetCollection<TDocument>(collection) devuelve un objeto MongoCollection que representa la colección. En este tutorial, se invocan los métodos siguientes en la colección:

• DeleteOneAsync: elimina un único documento que cumpla los criterios de búsqueda proporcionados.
• Find<TDocument>: devuelve todos los documentos de la colección que cumplen los criterios de búsqueda indicados.
• InsertOneAsync: inserta el objeto proporcionado como un nuevo documento en la colección.
• ReplaceOneAsync: reemplaza un único documento que cumpla los criterios de búsqueda indicados por el objeto proporcionado.

Incorporación de un controlador

Agregue una clase BooksController al directorio Controllers con el código siguiente:

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();
    }
}

El controlador de API web anterior:

• Usa la clase BooksService para ejecutar operaciones CRUD.
• Contiene métodos de acción para admitir las solicitudes GET, POST, PUT y DELETE de HTTP.
• Llama a CreatedAtAction en el método de acción Create para devolver una respuesta HTTP 201. El código de estado 201 es la respuesta estándar para un método HTTP POST que crea un recurso en el servidor. CreatedAtAction también agrega un encabezado Location a la respuesta. El encabezado Location especifica el identificador URI del libro recién creado.

Configuración de las opciones de serialización de JSON

Hay dos detalles que cambiar sobre las respuestas JSON devueltas en la sección Prueba de la API web:

• Las mayúsculas y minúsculas Camel predeterminadas de los nombres de propiedad se deben cambiar para que coincidan con el uso de mayúsculas y minúsculas de Pascal de los nombres de propiedad del objeto CLR.
• La propiedad bookName se debe devolver como Name.

Para satisfacer los requisitos anteriores, realice los cambios siguientes:

1. En Program.cs, encadena el siguiente código resaltado a la llamada al método AddControllers:

   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);
   

   Con el cambio anterior, los nombres de propiedad de la respuesta JSON serializada de la API web coinciden con sus nombres de propiedad correspondientes en el tipo de objeto CLR. Por ejemplo, la propiedad Book de la clase Author se serializa como Author, en lugar de author.

2. En Models/Book.cs, anote la propiedad BookName con el atributo [JsonPropertyName]:

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

   El valor [JsonPropertyName] del atributo Name representa el nombre de propiedad en la respuesta JSON serializada de la API web.

3. Agregue el código siguiente en la parte superior de Models/Book.cs para resolver la referencia al atributo [JsonProperty]:

   using System.Text.Json.Serialization;
   

4. Repita los pasos definidos en la sección Prueba de la API web. Observe la diferencia en los nombres de propiedad JSON.

Prueba de la API web

Visual Studio

En este tutorial se usan el Explorador de puntos de conexión y los archivos .http para probar la API.

1. Compile y ejecute la aplicación.

2. En Endpoints Explorer, haga clic con el botón derecho en el primer GET punto de conexión /api/books y seleccione Generar solicitud.

   El siguiente contenido se agrega al BookStoreApi.http archivo. Si es la primera vez que se genera una solicitud, el archivo se crea en la raíz del proyecto.

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

   El número de puerto ya debe establecerse en el puerto usado por la aplicación, por ejemplo, https://localhost:56874. Si no es así, puede encontrar el número de puerto en la ventana de salida al iniciar la aplicación.

3. Seleccione el vínculo Enviar solicitud encima de la nueva GET línea de solicitud.

   La solicitud GET se envía a la aplicación y la respuesta se muestra en el panel Respuesta.

4. El cuerpo de la respuesta muestra el resultado JSON que contiene las entradas del libro similares a las siguientes:

   [
     {
       "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. Para recuperar un único libro, haga clic con el botón derecho en el /api/books/{id}, params (string id) punto de conexión GET en el Explorador de puntos de conexión y seleccione Generar solicitud.

   El siguiente contenido se anexa al BookStoreApi.http archivo:

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

6. Reemplace id la variable por uno de los identificadores devueltos de la solicitud anterior, por ejemplo:

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

7. Seleccione el vínculo Enviar solicitud encima de la nueva GET línea de solicitud.

   La solicitud GET se envía a la aplicación y la respuesta se muestra en el panel Respuesta.

8. El cuerpo de la respuesta muestra un JSON similar al siguiente:

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

9. Para probar el punto de conexión POST, haga clic con el botón derecho en el /api/books punto de conexión POST y seleccione Generar solicitud.

   El siguiente contenido se agrega al archivo BookStoreApi.http:

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

10. Reemplace el comentario Book por un objeto book como el cuerpo de la solicitud JSON:

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

11. Seleccione el vínculo Enviar solicitud encima de la línea de POST solicitud.

    La solicitud POST se envía a la aplicación y la respuesta se muestra en el panel Respuesta . La respuesta debe incluir el libro recién creado con su identificador asignado.

12. Por último, para eliminar un libro, haga clic con el botón derecho en el /api/books/{id}, params (string id) punto de conexión DELETE y seleccione Generar solicitud.

    El siguiente contenido se anexa al BookStoreApi.http archivo:

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

13. Reemplace la id variable por uno de los identificadores devueltos de la solicitud anterior y haga clic en Enviar solicitud. Por ejemplo:

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

Visual Studio Code

En este tutorial se usa la especificación openAPI (openapi.json) y la interfaz de usuario de Swagger para probar la API.

1. Instale swagger UI mediante la ejecución del comando siguiente:

dotnet add package NSwag.AspNetCore

El comando anterior agrega el paquete NSwag.AspNetCore , que contiene herramientas para generar documentos y interfaz de usuario de Swagger. Dado que nuestro proyecto usa OpenAPI, solo usamos el paquete NSwag para generar la interfaz de usuario de Swagger.

1. Configuración del middleware de Swagger

En Program.cs, agregue el código resaltado siguiente:

var app = builder.Build();

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

El código anterior habilita el middleware de Swagger para servir el documento JSON generado mediante la interfaz de usuario de Swagger. Swagger solo se habilita en un entorno de desarrollo. Si Swagger se habilita en un entorno de producción, pueden exponerse detalles potencialmente confidenciales sobre la implementación y la estructura de la API.

La aplicación usa el documento openAPI generado por OpenApi, ubicado en /openapi/v1.json, para generar la interfaz de usuario. Vea la especificación de OpenAPI generada para la API de WeatherForecast mientras se ejecuta el proyecto; para ello, vaya a https://localhost:<port>/openapi/v1.json en el explorador.

La especificación de OpenAPI es un documento en formato JSON que describe la estructura y las funcionalidades de la API, incluidos los puntos de conexión, los formatos de solicitud y respuesta, los parámetros, etc. Básicamente, es un plano técnico de la API que pueden usar varias herramientas para comprender e interactuar con la API.

1. Compile y ejecute la aplicación.

2. Vaya a https://localhost:<port>/swagger en el explorador. Swagger proporciona una interfaz de usuario para probar todos los puntos de conexión de API en función del documento openAPI.

3. Expanda el punto de conexión GET /api/books y haga clic en el botón Pruébelo.

4. Haga clic en el botón Ejecutar para enviar la solicitud a la API.

5. La sección Cuerpo de respuesta muestra una matriz JSON con libros similares a los siguientes:

   [
     {
       "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. A continuación, expanda el punto de conexión GET /api/books/{id} y haga clic en Pruébelo.

7. Escriba uno de los identificadores de libro de la respuesta anterior en el campo id y, a continuación, haga clic en Ejecutar.

8. La sección Cuerpo de respuesta muestra el objeto JSON del libro especificado. Por ejemplo, el resultado del identificador 61a6058e6c43f32854e51f52 es similar al siguiente:

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

9. Para probar la creación de un libro, expanda el punto de conexión POST /api/books y haga clic en Probarlo.

10. Reemplace el cuerpo de la solicitud predeterminado por un nuevo objeto book:

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

11. Haga clic en Ejecutar para enviar la solicitud.

12. La respuesta debe tener un código de estado de 201 (creado) e incluir el libro recién creado con su identificador asignado en el cuerpo de la respuesta.

13. Por último, para eliminar un registro de libro, expanda el punto de conexión DELETE /api/books/{id} , haga clic en Probar y escriba uno de los identificadores de libro de la respuesta anterior en el campo id . Haga clic en Ejecutar para enviar la solicitud.

14. La respuesta debe tener un código de estado 204 (Sin contenido), lo que indica que el libro se eliminó correctamente.

Agregar compatibilidad con la autenticación a una API web

ASP.NET Core Identity agrega la funcionalidad de inicio de sesión de la interfaz de usuario (IU) a las aplicaciones web de ASP.NET Core. Para proteger las API web y las SPA, usa una de las siguientes opciones:

• Microsoft Entra ID
• Servidor Duende Identity

Duende Identity Server es un marco de OpenID Connect y OAuth 2.0 para ASP.NET Core. Duende Identity Server permite las siguientes características de seguridad:

• Autenticación como servicio (AaaS)
• Inicio de sesión único (SSO) mediante varios tipos de aplicaciones
• Control de acceso para API
• Puerta de enlace de federación

Important

Duende Software puede requerir que pagues una tarifa de licencia para el uso en producción de Duende Identity Server. Para obtener más información, consulte Migración de ASP.NET Core en .NET 5 a .NET 6.

Para más información, consulte la documentación de Duende Identity Server (sitio web de Duende Software).

Recursos adicionales

• Vea o descargue el código de ejemplo (cómo descargarlo)
• Creación de API web con ASP.NET Core
• Tipos de valores devueltos de acciones de controlador en la API web de ASP.NET Core
• Creación de una API web con ASP.NET Core