JOS.Epi.ContentApi updated to version 3.0.0

Thanks to the discussion in the comments on the blogpost written by Johan Björnfot I could simplify the code a lot and remove the HttpModule.

Version 3.0.0 is now available on the nuget feed.

It's a major version bump since I removed the HttpModule, you will need to remove the ContentApiModule entry in your web.config to make it work.

Remove the following entry

<system.webServer>  
  <modules>
    .....
    <add name="ContentApiModule" type="JOS.Epi.ContentApi.ContentApiModule, JOS.Epi.ContentApi" />
    ....
  </modules>    
</system.webServer>  
Headless Episerver? Meet JOS.Epi.ContentApi

Headless Episerver? Meet JOS.Epi.ContentApi

I read this blog post by Mathias Kunto where he says that he will leave my beloved library behind and start using the new Episerver Headless API instead.

I felt like the picture above :(

I couldn't stand it. So, I decided to create a new library; meet JOS.Epi.ContentApi..
JOS.Epi.ContentApi uses JOS.ContentSerializer by default(this can be changed by swapping out the IContentApiSerializer) so you don't need to have Episerver Find to use it.

I haven't had the time to try out the new Episerver version so I don't know how well it works, but I noticed this quote from Mathias:

I had a quick look at the API functionality, and it seems like you get pretty JSON requesting URLs like /api/episerver/v1.0/content/3 and so on. However, what I really wanted was friendly URLs delivering JSON for the page in question. For instance, requesting /en/alloy-plan/download-alloy-plan/start-downloading/ would give me JSON for the Start Downloading page.

I don't like that you must know the ContentReference to fetch the JSON data, it would be better if it worked like Mathias wants it to work.

I've built that.

How to use it

  1. Install-Package Jos.Epi.ContentApi(Normal nuget, not episerver feed)
  2. Set your accept header to "application/json" and make a GET request to your desired page. Note: When the package gets installed, a transform to your web.config will be applied and add the following line:
    <add name="ContentApiModule" type="JOS.Epi.ContentApi.ContentApiModule, JOS.Epi.ContentApi" xdt:Transform="Insert" /> If it doesn't work, add it yourself at/configuration/system.webServer/modules/
  3. Profit.

Note, by default(this can be changed) the library will only serialize the response if the Accept header contains ONE value, not two, not empty, one.
If you want to change this behaviour, just swap out the IShouldSerializeResponseStrategy interface.

You can also customize when/if the serialization should take place in the same method.

Demo

This is version 1, I've already started working on filtering and stuff like that, stay tuned!

As always, the code can be found on Github.

Beware of Enum.TryParse

What do you think Enum.TryParse will return when running this code?

public enum ContactMethod  
{
   Unknown = 0,
   Email = 1,
   Phone = 2
}

var result = Enum.TryParse("10", out ContactMethod contactMethod);  

"It will return false of course, 10 is not a valid value!!"

Wrong. It will return true. And even worse, the output variable contactMethod will have the value of...10!

Don't believe me? See it for yourself (dotnetfiddle)

Now, imagine that some developer wrote the following program:

public class Program  
{
    public static void Main(string args[])
    {
        var result = Enum.TryParse(args[0], out NukeStatus nukeStatus);
        FireNuke((int)nukeStatus);
    }

    public static void FireNuke(int status)
    {
        if(status == 0)
        {
           return;
        }

        if(status > 0 && status <= 10)
        {
           Console.WriteLine("TEST FIRING");
           TestFire();
        }

        if(status >= 15)
        {
           Console.WriteLine("NUKE EM ALL!");
           NukeEmAll();
        }
    }
}

public enum NukeStatus  
{
   Idle = 0,
   TestFireOneMissile = 5,
   TestFireAllMissiles = 10,
   FireOneMissile = 15,
   FireAllMissiles = 20
}

Now imagine that someone with fat fingers should do a test run and slips on the keyboard, so instead of passing in 10, 100 will be passed in instead.

dotnet run TrumpNukeProgram 100  

BOOM

Now, I know that my example is really stupid and the code is really bad, but still, it could happen!

What to use instead of Enum.TryParse then?

Note, this is only a problem when you try to pass in numeric values to TryParse.
If you want to be sure that your (int)value really exists in the Enum, you could use Enum.IsDefined instead.
Something like this:

var nukeStatusAsString = "100";  
var myNukeStatus = int.Parse(nukeStatusAsString); // Yeah yeah, error checking I know.  
var isDefined = Enum.IsDefined(typeof(NukeStatus), myNukeStatus);  
if (!isDefined)  
{
    return NukeStatus.Idle;
}
return (NukeStatus)myNukeStatus;  

You can read more about this here (Stackoverflow) and here (Microsoft).