Generar hipermedia enlaces en una API web

Question

Tengo curiosidad por saber cómo otros han tratado el tema de la generación de hipermedia enlaces para sus API web? Específicamente, estoy usando ASP.NET Web API, y estoy dividido entre hacer que las operaciones devuelvan tipos relacionados con hipermedia, o devolver el recurso en sí, y que el material hipermedia ocurra más adelante en la tubería. Es decir, ¿la gente tiende a hacer cosas como:

public Resource<Order> GetOrder(int id) { 
    return new Resource<Order>() { 
     Content = new Order(), 
     Links = new LinkCollection<Order>() { new AddOrderLink(), new UpdateOrderLink()} 
    } 

O algo más como

public Order GetOrder(int id) { return new Order(); } 

Y a continuación, añadir enlaces hipermedia dentro de un formateador HttpOperationHandler o costumbre o algo?

Si el enfoque es más parecido al # 2, ¿cómo sabe qué enlaces generar? ¿Solo tiene algún conjunto estándar de enlaces que se generan para todos los objetos Order? ¿Atributos que decoran varias operaciones en OrdersController?

Answer 1

Prefiero la opción dos (agregando los hipermedia enlaces más adelante en la tubería) y blogged about doing this yesterday.

La solución fue "enriquecer" mis recursos con hipermedia enlaces antes de que se devuelvan al cliente utilizando un controlador de mensajes.

Answer 2

Puede utilizar el Hyprlinkr de github

tengo la intención de usarlo en mi próximo proyecto, ya que seens de ser agradable y fácil de hacerlo y lo puede conseguir a través de paquete Nuget.

Answer 3

Para responder a esta pregunta, es instructivo mirar hacia el enfoque de ASP.NET MVC para el manejo de este, ya que ASP.NET MVC puede ser visto como un texto/versión de la API de Web HTML con limitaciones (a pesar de la negociación de contenido Manual), y dado que obviamente influyó mucho en el diseño de la API web.

Básicamente, podemos usar formateadores personalizados para variar las representaciones basadas en la ruta o un atributo de acción. Esto se informa por la forma en que ASP.NET MVC separa las vistas de los modelos. En un proyecto ASP.NET MVC, varias plantillas de vistas pueden representar un único modelo. Cada una de estas plantillas de vista esencialmente enlaces "duros" de transición (ancla, forma y elementos de enlace) en esa representación particular del modelo. La selección de la plantilla de vista se maneja predominantemente por convención (controlador y nombre de acción), pero también puede codificarse en la acción.

El motor de vista y la convención de búsqueda en ASP.NET MVC se pueden considerar un formateador de API Web personalizado. Esto se puede generalizar de forma tal que, para cada tipo de medio admitido, un formateador personalizado utilice detalles de ruta, y opcionalmente un atributo aplicado al método de acción invocado, para definir el estado del recurso. (Según esta convención, se obtienen beneficios al elegir los nombres de las acciones que reflejan el estado del recurso). Una vez que el formateador conoce el estado del recurso, puede delegar en el código de formato específico del estado. En este código es donde se definirían los enlaces específicos del estado.

Este código de formato específico del estado también podría delegar a otros subformatters, de la misma manera que las vistas de Razor admiten la composición de vistas parciales.

Answer 4

he añadido mi solución here

Utiliza clase y los atributos de la propiedad en combinación con un método de extensión ApiController para rellenar un objeto ResourceLink en su entidad. También puede llenar enlaces para cualquier propiedad de colección. No es el artículo terminado, pero es bastante intuitivo y hará un buen comienzo.