RestSelfHost

This a implementation of a Self Hosted API using OWIN, OData, Authentication with immutable Key and SQL Server Database.

Prerequisities

This is our Database script:

CREATE DATABASE [selfhostwebapi]
 CONTAINMENT = NONE
 ON  PRIMARY 
( NAME = N'selfhostwebapi', FILENAME = N'C:\Users\Public\selfhostwebapi.mdf' , SIZE = 5120KB , MAXSIZE = UNLIMITED, FILEGROWTH = 1024KB )
 LOG ON 
( NAME = N'selfhostwebapi_log', FILENAME = N'C:\Users\Public\selfhostwebapi_log.ldf' , SIZE = 1024KB , MAXSIZE = 2048GB , FILEGROWTH = 10%)

And our Invoice Table

CREATE TABLE [dbo].[invoice](
	[CreatedAt] [datetime] NOT NULL,
	[ReferenceMonth] [int] NOT NULL,
	[ReferenceYear] [int] NOT NULL,
	[Document] [varchar](14) NOT NULL,
	[Description] [varchar](256) NOT NULL,
	[Amount] [decimal](16, 2) NOT NULL,
	[IsActive] [bit] NOT NULL,
	[DeactiveAt] [datetime] NULL,
	[Id] [int] IDENTITY(1,1) NOT NULL,
 CONSTRAINT [PK_invoice] PRIMARY KEY CLUSTERED 
(
	[Id] ASC
)WITH (PAD_INDEX = OFF, STATISTICS_NORECOMPUTE = OFF, IGNORE_DUP_KEY = OFF, ALLOW_ROW_LOCKS = ON, ALLOW_PAGE_LOCKS = ON) ON [PRIMARY]
) ON [PRIMARY]

API Usage

We accept only GET, POST and DELETE verbs. If you try a PUT verb, you will receive a 405.

Example

Insert a Authorization Header with restSelfHostToken value. Then:

GET http://localhost:5000/api/v1/invoice/75

GET http://localhost:5000/api/v1/invoice

POST http://localhost:5000/api/v1/invoice

Body:
{
  "CreatedAt" : "2016-02-15",
  "ReferenceMonth" : 4,
  "ReferenceYear" : 2016,
  "Document" : "05454",
  "Description" : "VAMOS COM TUDO!",
  "Amount" : 10,
  "IsActive" : true
}

DELETE http://localhost:5000/api/v1/invoice/1

Filtering, Sorting and Pagination

We use OData to make that hard work for us!

GET localhost:5000/api/v1/invoice?$filter=Id ge 70

GET localhost:5000/api/v1/invoice?$orderby=ReferenceMonth desc, Id asc

GET localhost:5000/api/v1/invoice?$top=10&$skip=20

For more examples, see the ODAta Official Website.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Author

Tiago Brandão aka Tiago Potência - LinkedIn