This is a sample code for HAL and Swagger integration

_hal-swagger-sample.txt

This is a sample code for HAL and Swagger integration

* http://devkimchi.com/2041/creating-service-contract-with-autorest-swagger-and-hal
* http://blog.kloud.com.au/2015/10/26/creating-service-contract-with-autorest-swagger-and-hal

build.bat

..\..\packages\autorest.0.11.0\tools\AutoRest.exe
  -Input swagger.json
  -Namespace HalSwaggerSample.WebApp.Proxies
  -OutputDirectory ..\Proxies
  -CodeGenerator CSharp

get-product-collection-hal.json

{
  "_embedded": {
    "products": [
      {
        "productId": 5,
        "productName": "My Product 5",
        "price": 150.00,
        "_links": {
          "self": { "href": "/products/5" },
          "find": { "href": "/products/{productId}", "templated": true },
          "collection": { "href": "/products" } 
        }
      },
      {
        "productId": 6,
        "productName": "My Product 6",
        "price": 200.00,
        "_links": {
          "self": { "href": "/products/5" },
          "find": { "href": "/products/{productId}", "templated": true },
          "collection": { "href": "/products" } 
        }
      }
    ]
  },
  "_links": {
    "self": { "href": "/products" }
  }
}

get-product-collection.json

{
  "products": [
    {
      "productId": 5,
      "productName": "My Product 5",
      "price": 150.00
    },
    {
      "productId": 6,
      "productName": "My Product 6",
      "price": 200.00
    }
  ]
}

get-product-collection.txt

GET https://my.api.service/products

get-product-hal.json

{
  "productId": 5,
  "productName": "My Product",
  "price": 150.00,
  "_links": {
    "self": { "href": "/products/5" },
    "find": { "href": "/products/{productId}", "templated": true },
    "collection": { "href": "/products" } 
  }
}

get-product.json

{
  "productId": 5,
  "productName": "My Product",
  "price": 150.00
}

get-product.txt

GET https://my.api.service/products/5

hal-config.cs

var config = GlobalConfiguration.Configuration;

var jsonFormatter = new JsonHalMediaTypeFormatter();
jsonFormatter
  .SerializerSettings
  .ContractResolver = new CamelCasePropertyNamesContractResolver();

config.Formatters.Insert(0, jsonFormatter);
config.Formatters.Insert(0, new XmlHalMediaTypeFormatter());

product-api-controller-hal.cs

[RoutePrefix("products")]
public class ProductController
{
  [Route("{productId}")
  public virtual async Product GetProduct(int productId)
  {
    var product = await this._service.GetProductAsync(productId);
  
    product.Rel = "product";
    product.Href = "/products/" + productId;
    product.Links = new List<Link>()
                    {
                      new Link("self", "/products/" + productId),
                      new Link("find", "/products/{productId}"),
                      new Link("collection", "/products"),
                    };
    return product;
  }
}

product-mvc-controller.cs

[RoutePrefix("products")]
public virtual class ProductController : Controller
{
  private readonly IHalSwaggerSampleHalApiApp _proxy;

  public ProductController(IHalSwaggerSampleHalApiApp proxy)
  {
    this._proxy = proxy;
  }

  [Route("view/{productId}")]
  public virtual async Task<ActionResult> ViewProduct(int productId)
  {
    var response = await this._proxy
                             .ProductOperations
                             .GetProductWithHttpMessagesAsync(productId);
    var product = response.Body;
    return View(product);
  }
}

product-product-collection-model-hal.cs

public class Product : Representation
{
  public int ProductId { get; set; }
  public string ProductName { get; set;}
  public decimal Price { get; set; }
}

public class ProductCollection : SimpleListRepresentation<Product>
{
  public ProductCollection()
      : base ()
  {
  }

  public ProductCollection(IEnumerable<Product> items)
      : base (items.ToList())
  {
  }
}

product-product-collection-model.cs

public class Product
{
  public int ProductId { get; set; }
  public string ProductName { get; set;}
  public decimal Price { get; set; }
}

public class ProductCollection
{
  public ProductCollection()
  {
    this.Items = new List<Product>();
  }

  public ProductCollection(IEnumerable<Product> items)
  {
    this.Items = items.ToList();
  }

  public List<Product> Items { get; private set; }
}

swagger-config-after.cs

//[assembly: PreApplicationStartMethod(typeof(SwaggerConfig), "Register")]
namespace HalSwaggerSample.HalApiApp
{
  public static class SwaggerConfig
  {
    public static void Register(this HttpConfiguration config)
    {
      ...
      config.EnableSwagger(c =>
      ... 
    }
  }
}

swagger-config-before.cs

[assembly: PreApplicationStartMethod(typeof(SwaggerConfig), "Register")]
namespace HalSwaggerSample.HalApiApp
{
  public class SwaggerConfig
  {
    public static void Register()
    {
      ...
      GlobalConfiguration.Configuration
        .EnableSwagger(c =>
      ... 
    }
  }
}

swagger-config.cs

config.ConfigSwagger();