APIToGoAPIToGo
Sample Dotnet Backend
  • API Reference
  • Pricing
Information
Meta
    API welcome messageget
Health
    Health check (deploy probe)get
Items
    List itemsgetCreate itempostGet item by idgetReplace itemputDelete itemdeletePartially update itempatch
Echo
    Echo JSON bodypostEcho form-urlencoded bodypostEcho multipart form (optional file)post
Utilities
    Basic arithmeticpostSearch items by textgetReflect request headersget
Test
    Plain text responsegetReturn arbitrary HTTP statusget
Schemas
powered by apitogo
sample-dotnet-backend
sample-dotnet-backend

Items

Endpoint

List items

GET
http://localhost:5088
/api/items

List items › query Parameters

category
​string

Filter by category (case-insensitive)

List items › Responses

200

Item list

count
​integer
​object[]
GET/api/items
curl --request GET \ --url http://localhost:5088/api/items
shell
Example Responses
{ "count": 0, "items": [ { "id": "00000000-0000-0000-0000-000000000000", "name": "name", "description": "description", "category": "category", "price": 0, "createdAt": "2024-08-25T15:00:00Z", "updatedAt": "2024-08-25T15:00:00Z" } ] }
json
application/json

Create item

POST
http://localhost:5088
/api/items

Create item › Request Body

name
​string · minLength: 1 · maxLength: 200 · required
price
​number · decimal · min: 0 · max: 1000000 · required
description
​string | null · maxLength: 2000
category
​string | null · maxLength: 100

Create item › Responses

Created

id
​string · uuid · required
name
​string · required
price
​number · decimal · required
createdAt
​string · date-time · required
description
​string | null
category
​string | null
updatedAt
​string | null · date-time
POST/api/items
curl --request POST \ --url http://localhost:5088/api/items \ --header 'Content-Type: application/json' \ --data ' { "name": "name", "description": "description", "category": "category", "price": 0 } '
shell
Example Request Body
{ "name": "name", "description": "description", "category": "category", "price": 0 }
json
Example Responses
{ "id": "00000000-0000-0000-0000-000000000000", "name": "name", "description": "description", "category": "category", "price": 0, "createdAt": "2024-08-25T15:00:00Z", "updatedAt": "2024-08-25T15:00:00Z" }
json
application/json

Get item by id

GET
http://localhost:5088
/api/items/{id}

Get item by id › path Parameters

id
​string · uuid · required

Get item by id › Responses

Item found

id
​string · uuid · required
name
​string · required
price
​number · decimal · required
createdAt
​string · date-time · required
description
​string | null
category
​string | null
updatedAt
​string | null · date-time
GET/api/items/{id}
curl --request GET \ --url http://localhost:5088/api/items/:id
shell
Example Responses
{ "id": "00000000-0000-0000-0000-000000000000", "name": "name", "description": "description", "category": "category", "price": 0, "createdAt": "2024-08-25T15:00:00Z", "updatedAt": "2024-08-25T15:00:00Z" }
json
application/json

Replace item

PUT
http://localhost:5088
/api/items/{id}

Replace item › path Parameters

id
​string · uuid · required

Replace item › Request Body

name
​string · minLength: 1 · maxLength: 200 · required
price
​number · decimal · min: 0 · max: 1000000 · required
description
​string | null · maxLength: 2000
category
​string | null · maxLength: 100

Replace item › Responses

Updated

id
​string · uuid · required
name
​string · required
price
​number · decimal · required
createdAt
​string · date-time · required
description
​string | null
category
​string | null
updatedAt
​string | null · date-time
PUT/api/items/{id}
curl --request PUT \ --url http://localhost:5088/api/items/:id \ --header 'Content-Type: application/json' \ --data ' { "name": "name", "description": "description", "category": "category", "price": 0 } '
shell
Example Request Body
{ "name": "name", "description": "description", "category": "category", "price": 0 }
json
Example Responses
{ "id": "00000000-0000-0000-0000-000000000000", "name": "name", "description": "description", "category": "category", "price": 0, "createdAt": "2024-08-25T15:00:00Z", "updatedAt": "2024-08-25T15:00:00Z" }
json
application/json

Delete item

DELETE
http://localhost:5088
/api/items/{id}

Delete item › path Parameters

id
​string · uuid · required

Delete item › Responses

Deleted

No data returned
DELETE/api/items/{id}
curl --request DELETE \ --url http://localhost:5088/api/items/:id
shell
Example Responses
No example specified for this content type

Partially update item

PATCH
http://localhost:5088
/api/items/{id}

Partially update item › path Parameters

id
​string · uuid · required

Partially update item › Request Body

name
​string | null · minLength: 1 · maxLength: 200
description
​string | null · maxLength: 2000
category
​string | null · maxLength: 100
price
​number | null · decimal · min: 0 · max: 1000000

Partially update item › Responses

Patched

id
​string · uuid · required
name
​string · required
price
​number · decimal · required
createdAt
​string · date-time · required
description
​string | null
category
​string | null
updatedAt
​string | null · date-time
PATCH/api/items/{id}
curl --request PATCH \ --url http://localhost:5088/api/items/:id \ --header 'Content-Type: application/json' \ --data ' { "name": "name", "description": "description", "category": "category", "price": 0 } '
shell
Example Request Body
{ "name": "name", "description": "description", "category": "category", "price": 0 }
json
Example Responses
{ "id": "00000000-0000-0000-0000-000000000000", "name": "name", "description": "description", "category": "category", "price": 0, "createdAt": "2024-08-25T15:00:00Z", "updatedAt": "2024-08-25T15:00:00Z" }
json
application/json

HealthEcho