Modelo de URL de detalles del paquete

  • Artículo

Es posible que un cliente genere una dirección URL que el usuario pueda utilizar para ver más detalles del paquete en su navegador web. Esto resulta útil cuando un origen de paquete quiere mostrar información adicional sobre un paquete que puede no ajustarse al ámbito de lo que muestra la aplicación cliente de NuGet.

El recurso que se utiliza para generar esta URL es el recurso PackageDetailsUriTemplate que se encuentra en el índice de servicio.

Control de versiones

Se usan los siguientes valores @type:

Valor de @type Notas
PackageDetailsUriTemplate/5.1.0 La versión inicial

URL template

La dirección URL de la siguiente API es el valor de la propiedad @id asociada a uno de los valores @type de los recursos mencionados anteriormente.

Métodos HTTP

Aunque el cliente no está pensado para realizar solicitudes a la dirección URL de detalles del paquete en nombre del usuario, la página web debe admitir el método GET para permitir abrir fácilmente una dirección URL en un navegador web cuando se hace clic en ella.

Construcción de la dirección URL

Dada una versión y un id. de paquete conocidos, la implementación del cliente puede construir una dirección URL que se utilice para acceder a una interfaz web. La implementación del cliente debe mostrar al usuario esta dirección URL construida (o vínculo en el que se puede hacer clic) para poder abrir un navegador web en el que dicha dirección URL le permita conocer más detalles sobre el paquete. La implementación del servidor determina el contenido de la página de detalles del paquete.

La dirección URL debe ser una dirección URL absoluta y el esquema (protocolo) debe ser HTTPS.

El valor de @id el índice de servicio es una cadena de dirección URL que contiene cualquiera de los siguientes tokens de marcador de posición:

Marcadores de posición de dirección URL

Nombre Type Obligatorio Notas
{id} string no Id. del paquete del que se van a obtener detalles
{version} string no Versión del paquete del que se van a obtener detalles

El servidor debe aceptar los valores {id} y {version} independientemente de si están expresados en mayúsculas o minúsculas. Además, el servidor no debe distinguir si la versión está o no normalizada. En otras palabras, el servidor también debe aceptar versiones no normalizadas.

Por ejemplo, la plantilla de detalles del paquete de nuget.org tiene el siguiente aspecto:

https://www.nuget.org/packages/{id}/{version}

Si la implementación del cliente necesita mostrar un vínculo a los detalles del paquete para NuGet.Versioning 4.3.0, generaría la siguiente dirección URL y la proporcionaría al usuario:

https://www.nuget.org/packages/NuGet.Versioning/4.3.0