An open API service indexing awesome lists of open source software.

https://github.com/fabiangosebrink/aspnetcore-webapi-sample

This is a sample ASP.NET Core WebAPI
https://github.com/fabiangosebrink/aspnetcore-webapi-sample

asp-net-core aspnetcore webapi webapi-sample

Last synced: 9 days ago
JSON representation

This is a sample ASP.NET Core WebAPI

Awesome Lists containing this project

README

        

# ASP.NET Core WebApi Sample with HATEOAS, Versioning & Swagger

In this repository I want to give a plain starting point at how to build a WebAPI with ASP.NET Core.

This repository contains a controller which is dealing with FoodItems. You can GET/POST/PUT/PATCH and DELETE them.

Hope this helps.

See the examples here:

## Versions

``` http://localhost:29435/swagger ```

![ASPNETCOREWebAPIVersions](./.github/versions.jpg)

## GET all Foods

``` http://localhost:29435/api/v1/foods ```

![ASPNETCOREWebAPIGET](./.github/get.jpg)

## GET single food

``` http://localhost:29435/api/v1/foods/2 ```

![ASPNETCOREWebAPIGET](./.github/getSingle.jpg)

## POST a foodItem

``` http://localhost:29435/api/v1/foods ```

```javascript
{
"name": "Lasagne",
"type": "Main",
"calories": 3000,
"created": "2017-09-16T17:50:08.1510899+02:00"
}
```

![ASPNETCOREWebAPIGET](./.github/post.jpg)

## PUT a foodItem

``` http://localhost:29435/api/v1/foods/5 ```

``` javascript
{
"name": "Lasagne2",
"type": "Main",
"calories": 3000,
"created": "2017-09-16T17:50:08.1510899+02:00"
}
```

![ASPNETCOREWebAPIGET](./.github/put.jpg)

## PATCH a foodItem

``` http://localhost:29435/api/v1/foods/5 ```

``` javascript
[
{ "op": "replace", "path": "/name", "value": "mynewname" }
]
```

![ASPNETCOREWebAPIGET](./.github/patch.jpg)

## DELETE a foodItem

``` http://localhost:29435/api/v1/foods/5 ```

![ASPNETCOREWebAPIGET](./.github/delete.jpg)