The purpose of this project is to give a sense for how well I am able to get started building REST APIs using .Net Core and JSON API .Net Core framework while following the JSONAPI specification.
I haven't yet had explicit .NET Core experience so this is a great opportunity for me to get my feet wet and demonstrate my abilty to complete a basic set of api tasks.
I've chosen to use my Windows 10 laptop because dotNetCore 2.x has macOs 10.12 "Sierra" as a prerequisite and the MacBook pro I use is on 10.11.06. I used Visual Studio Enterprise 2017 as my Integrated Development Environment.
As directed, I will be using Entity Framework Core alongside JSONAPI .Net Core to create a few models, define their structure, and then create controllers to expose them to the outside world with the typical set of CRUD operations. For convenience sake I have choosen SQLite for my database, normally I prefer SQL Server 2012 for corporate projects, and Postgres for open source projects.
EF Migrations are enabled in the project, on the first startup a SQLite DB will be created and seeded with some sample data, the project should be set up such that you can clone and run in IISExpress with /authors as the default endpoint. The JSON API .NET Core settings are using absolute urls so self links can be clicked on to drill into child collections.
I've also created all of the solution files in one WebApi project, normally I would inlude separate class libraries with one for Repositories (DAL), and another for Domain (Models) but this is being created simply to demonstrate basic competency in .Net Core Web Api.
I've created three models as follows:
| Author |
|---|
| Id |
| FirstName |
| LastName |
| Books |
| Book |
|---|
| Id |
| Title |
| Isbn |
| PublishDate |
| Reviews |
| Review |
|---|
| Id |
| ReviewerName |
| ReviewBody |
The relationships defined between these models are such that authors may have many books, and books may have many reviews.
I deployed this project to the web at a domain I own (dottlebot.com), it is being hosted on a HyperV VM in my office that is running Server 2012 R2.
Each of these endpoints support basic CRUD operations following the JSONApi standard Http Verbs. (POST, GET, PATCH, and DELETE)
- Samples Folder with links to the completed Requests and responses that demonstrate successful completion of each of the CRUD operations.
- PostMan export - Download and import into PostMan to exercise endpoints against local project.