Skip to content

Sponsor: Do you build complex software systems? See how NServiceBus makes it easier to design, build, and manage software systems that use message queues to achieve loose coupling. Get started for free.

Learn more about Software Architecture & Design.
Join thousands of developers getting weekly updates to increase your understanding of software architecture and design concepts.


Follow @CodeOpinion

HTTP API

Self Descriptive HTTP API in ASP.NET Core: HATEOAS

This post is in my Self Descriptive HTTP API in ASP.NET Core series. It demonstrates how to design an HTTP API like a regular HTML website. Bringing the concepts of links and actions to your API allows your clients to consume it with ease. If you’re new to this series, here are earlier posts to get up to speed: Intro Object as Resource Hypermedia Siren If you have any questions, please follow me on Twitter. Actions In my last post I covered outputting a siren hypermedia payload from our ASP.NET Core MVC application.  Specifically I showed linking to each Todo item within… Read More »Self Descriptive HTTP API in ASP.NET Core: HATEOAS

Self Descriptive HTTP API in ASP.NET Core: Siren

This post is in my Self Descriptive HTTP API in ASP.NET Core series. It demonstrates how to design an HTTP API like a regular HTML website. Bringing the concepts of links and actions to your API allows your clients to consume it with ease. If you’re new to this series, here are earlier posts to get up to speed: Intro Object as Resource Hypermedia If you have any questions, please follow me on Twitter. Siren I mentioned that Siren was one media type that appeals to me because it supports both links and actions.  This is important because I generally build core… Read More »Self Descriptive HTTP API in ASP.NET Core: Siren

Self Descriptive HTTP API in ASP.NET Core: Object as Resource

In my opening post I went over some of the issues I encountered when initially developing an HTTP API.  In this post I’m going to cover some of those pain points and what I think the solution was. Objects The first pain point revolves around the idea of your HTTP API returning objects.  Meaning you serialize an object to JSON and return to the client. This seems pretty typical.   Almost every example you find in regards to Web API describes this behavior. Here’s an example of what this looks like: View the code on Gist. We’re doing nothing more than… Read More »Self Descriptive HTTP API in ASP.NET Core: Object as Resource