CRUD (Crear, Leer, Actualizar, Eliminar)

Artículo
11/01/2024

La API de administración de IIS proporciona acceso directo a los recursos del sistema. Muchos de estos recursos permiten operaciones de creación, lectura, actualización y eliminación. La API REST asigna operaciones CRUD a métodos HTTP. En la tabla siguiente se especifica qué método HTTP se asigna a qué operación.

Operación CRUD	Método HTTP
Crear	EXPONER
Leer	OBTENER
Actualizar	PATCH/PUT
Borrar	BORRAR

Crear (POST)

Los recursos se crean mediante el envío de solicitudes HTTP POST a la API. El tipo de recurso viene determinado por la dirección URL de la solicitud. El cuerpo de la solicitud debe contener un objeto JSON que describa el recurso que se va a crear. El objeto del cuerpo de la solicitud determina el estado inicial del recurso será cuando se cree. Algunos recursos requieren que se proporcionen determinadas propiedades cuando se crean, otras se pueden crear con un objeto JSON vacío.

Crear un recurso al establecer la propiedad name. POST

{
    "name": "Example Resource Name"
}

Creación de un recurso que pertenece a otro

A veces se crean recursos que están diseñados para pertenecer a otro recurso. Por ejemplo, si aplicaciones deben pertenecer a un sitio web y alguien quería crear una nueva aplicación , especificarían esa relación durante la creación de la aplicación, como se muestra a continuación.

Crear una aplicación para un sitio web. POST

{
    "path": "/MyApp",
    "physical_path": "c:/sites/mysite/myapp",
    "website": {
        "id": {website_id}
    }
}

Read (GET)

Los recursos se recuperan realizando solicitudes HTTP GET. Hay dos métodos principales para recuperar recursos. El primer método implica solicitar una lista de recursos, el segundo método es cuando se solicita un único recurso. Las solicitudes a un único recurso están marcadas por la presencia del identificador de de recurso en la dirección URL de la solicitud. A veces, los recursos singulares también se pueden especificar a través de los paremeters de cadena de consulta en la dirección URL. Este comportamiento depende del punto de conexión de API individual.

Recuperación de varios recursos

La lectura de listas de recursos se realiza solicitando un punto de conexión de recursos sin especificar un recurso individual id. A veces, los recursos requieren parámetros de cadena de consulta o, de lo contrario, no pueden generar listas válidas. Por ejemplo, las aplicaciones iiS residen en el punto de conexión de /api/webserver/webapps, pero solicitar ese punto de conexión por sí solo no generaría información. Esto se debe a que se debe especificar un sitio web para indicar a la API qué aplicaciones deben mostrarse. Por lo tanto, los consumidores solicitarían /api/webserver/webapps?website.id={website_id} para ver una lista de aplicaciones.

Recuperar una lista de recursos. GET/api/websites

{
    "websites": [
        {
            "name": "Default Web Site",
            "id": "{id}",
            "status": "started",
            "_links": {
                "self": {
                    "href": "/api/webserver/websites/{id}"
                }
            }
        },
        {
            "name": "My Site",
            "id": "{id_1}",
            "status": "started",
            "_links": {
                "self": {
                    "href": "/api/webserver/websites/{id_1}"
                }
            }
        }
        {
            "name": "docs",
            "id": "{id_2}",
            "status": "started",
            "_links": {
                "self": {
                    "href": "/api/webserver/websites/{id_2}"
                }
            }
        }
    ]
}

Recuperación de recursos individuales

Los recursos se recuperan de forma individual proporcionando el identificador de del recurso en la dirección URL del punto de conexión del recurso. Algunos puntos de conexión de API también permiten especificar recursos individuales al proporcionar parámetros de cadena de consulta de identificación únicos. Por ejemplo, un archivo se puede recuperar proporcionando el identificador de del archivo en la dirección URL o proporcionando el physical_path del archivo.

El recurso de archivo permite que varios métodos recuperen archivos individuales:

/api/files/{id}
/api/files?physical_path={ruta de acceso física del archivo}

El punto de conexión de archivos proporciona este comportamiento porque solo puede existir un archivo para cualquier ruta de acceso física determinada, por lo que es un identificar de forma única parámetro de cadena de consulta.

Actualización (PATCH/PUT)

Las actualizaciones se realizan mediante la emisión de solicitudes HTTP PATCH a la dirección URL en la que se encuentra el recurso. Cuando se realiza una solicitud PATCH, se leen las propiedades del cuerpo de la solicitud y, si el recurso tiene una propiedad con el mismo nombre, la propiedad del recurso se establecerá en el nuevo valor.

Recurso de ejemplo antes de PATCH

{
    "name": "My Site",
    "id": "12345",
    "physical_path": "c:\\sites\\mysite"
    "_links": {
        "self": {
            "href": "/api/webserver/websites/{12345}"
        }
    }
}

Realización de la solicitud PATCH

Solicitud de revisión para actualizar el nombre del recurso. PATCH/api/webserver/websites/12345

{
    "name": "My Site 2"
}

Recurso después de PATCH

{
    "name": "My Site 2",
    "id": "12345",
    "physical_path": "c:\\sites\\mysite"
    "_links": {
        "self": {
            "href": "/api/webserver/websites/{12345}"
        }
    }
}

Eliminar (DELETE)

Los recursos se eliminan mediante el envío de una solicitud HTTP DELETE a la dirección URL en la que se encuentra el recurso. Esta es la dirección URL que contiene el identificador de del recurso.

Compartir a través de