Skip to content

Latest commit

 

History

History
233 lines (196 loc) · 5.44 KB

readme.md

File metadata and controls

233 lines (196 loc) · 5.44 KB
Raw

Barebones Todo Minimal API - ASP.NET Core 8 (MSSQL)

A sample minimal todo list api in C# with ASP.NET Core 8. This project uses SQLServer/MSSQL for database. Check out /v7e5/bareapi_asp_core for a version that uses Sqlite.

Features

  • Builds on the bare minimum WebApplication.CreateEmptyBuilder
  • Implements a simple cookie based user authentication / session using raw http headers, backed by a session table in the database.
  • Avoids the complexity and ceremony of EFCore/ORMs in favor of raw sql queries/ADO.NET.
  • Uses Sql Server for database. Microsoft.Data.SqlClient is the only required package dependency.
  • Implements keyset/cursor based pagination for the todo/list route.

Notes

  • Tested with Microsoft SQL Server 2019 (RTM) - 15.0.2000.5 (X64).
  • Needs MultipleActiveResultSets to be enabled, so include MultipleActiveResultSets=true in your connection string.
  • Listening port and database connection string need to be defined in a config.json file in root. See config_sample.json to get started.
  • The sql query for listing todos todo/list uses a hackish method to convert aggregated categories to a json string, because of the absence of json aggregate functions in sqlserver 2019. It depends on setting CONCAT_NULL_YIELDS_NULL = ON, so that '[' + null + ']'evaluates to null. CONCAT_NULL_YIELDS_NULL is always set to ON by default on sqlserver 2017 and upwards, so you may not have to change anything.
  • InvariantGlobalization is set to false <InvariantGlobalization>false</InvariantGlobalization>. Ideally, it should be set true for apis, but setting it true breaks database stuff in my case (working on archlinux). You could try setting it to true and check if it works for you.
  • The shell scripts in misc are intended to be run in a zsh shell on linux. They include convenience functions for building / executing as well as testing the routes using curl. Feel free to ignore them if they don't match your use case.

Endpoints

Auth

login

POST: /login

Example request:

curl -vs -X POST \
  --cookie ${COOKIE_FILE_PATH} \
  --cookie-jar ${COOKIE_FILE_PATH} \
  -H 'content-type: application/json' \
  -H 'accept: application/json' \
  --data-binary "$(cat <<EOL
{
  "username": string (required),
  "passwd": string (required)
}
EOL
)" \
'http://0.0.0.0:8000/login'

logout

POST: /logout

Example request:

curl -vs -X POST \
  --cookie ${COOKIE_FILE_PATH} \
  --cookie-jar ${COOKIE_FILE_PATH} \
  -H 'content-type: application/json' \
  -H 'accept: application/json' \
'http://0.0.0.0:8000/logout'

Todos

todo: list

POST: /todo/list

This route implements keyset pagination. It is controlled by three optional parameters: cursor_init, cursor_prev and cursor_next. Initial request without any parameters returns a JSON response something like this:

{
  "data": [ // array of todos
    {todo object}
  ],
  "cursor_init": // index of first row (return with every next/prev request),
  "cursor_prev": //index of last page, use to go back (is null for first page)
  "cursor_next": //index for next page, use to go forward,
}

Include one of either cursor_next or cursor_prev along with cursor_init. To go forward, include the cursor_next param in your request, which you will have recieved from an earlier request. To go back, send cursor_prev. The value for cursor_init does not change for a given query. It is used as an anchor to determine if there are any rows while going backwards.

Example request:

curl -vs -X POST \
  --cookie ${COOKIE_FILE_PATH} \
  --cookie-jar ${COOKIE_FILE_PATH} \
  -H 'content-type: application/json' \
  -H 'accept: application/json' \
  --data-binary "$(cat <<EOL
{
  "id": int (optional),
  "task": string (optional),
  "done": bool (optional),
  "due_from": unix timestamp (long, optional),
  "due_to": unix timestamp (long, optional),
  "categories": [array of category ids (int, optional)],
  "cursor_init": int (optional),
  "cursor_next": int (optional),
  "cursor_prev": int (optional)
}
EOL
)" \
'http://0.0.0.0:8000/todo/list'

todo: create

POST: /todo/create

{
  "task": string (required),
  "done": bool (optional),
  "due": unix timestamp (long, optional),
  "categories": [array of category ids (int, optional)]
}

todo: update

POST: /todo/update

{
  "id": int (required),
  "task": string,
  "done": bool,
  "due": unix timestamp,
  "categories": [array of category ids]
}

todo: delete

POST: /todo/delete

{
  "id": int (required)
}

Users

user: create

POST: /user/create

{
  "username": string (required),
  "passwd": string (required)
}

user: delete

POST: /user/delete

{
  "id": int (required)
}

user: list

POST: /user/list

{
  "id": int (optional),
  "username": string (optional)
}

Categories

category: create

POST: /category/create

[
  {"name":"bug","color":"d73a4a"},
  {"name":"duplicate","color":"cfd3d7"}
]

category: list

POST: /category/list

{
  "id": int (optional),
  "name": string (optional),
  "color": string (optional)
}

category: update

POST: /category/update

{
  "id": int (required),
  "name": string,
  "color": string
}

category: delete

POST: /category/delete

{
  "id": int (required)
}