🚧 This is work in progress
API server for tiny bookmarking service
- node 14.x
Install dependencies:
npm installCreate empty database:
npm run syncStart dev server:
KEY="secret-key" npm run devProduction:
KEY="secret-key" npm startThis doc assume that your server running on https://dev.piny.link. The request examples uses httpie.
Emoji key:
- 🌍 Public endpoint
- 🔐 Requires authorisation
Headers:
Content-Type: application/json— default body typeAuthorization: Bearer XXX— replaceXXXwithtokenfrom/loginresponse (🔐 restricted endpoints only)
POST /signupuser: string— user name (unique)pass: string— user password (no restrictions)email: string— user email (unique)
http --json POST 'https://dev.piny.link/signup' \
'Content-Type':'application/json' \
user="foo" \
pass="1234" \
email="[email protected]"{
"message": "👋 Welcome, please /login"
}POST /loginuser: string— user namepass: string— user password
http --json POST 'https://dev.piny.link/login' \
'Content-Type':'application/json' \
pass="1234" \
user="foo"{
"token": "XXX",
}GET /logouthttp GET 'https://dev.piny.link/logout' \
'Authorization':'Bearer XXX'{
"message": "👋 Bye"
}GET /:useruser: string— user name
http GET 'https://dev.piny.link/:user' \
'Authorization':'Bearer XXX'{
"id": "YYY",
"name": "foo",
"email": "[email protected]"
}GET /:user?/bookmarksuser?: string— user name (if omitted, get bookmarks of current user)
http GET 'https://dev.piny.link/:user/bookmarks' \
'Authorization':'Bearer XXX'[
{
"id": "ff7b3bb2-5fad-4924-81a6-5bedc3ded3dd",
"title": "KayWay",
"description": "Illustration portfolio by Ekaterina Grishina",
"state": "active",
"privacy": "public",
"link": {
"id": "a6f7584f-c1a5-42e8-bd98-e1bb003fc219",
"url": "https://kayway.me/"
},
"tags": [
{
"id": "2c00e362-30fc-4dba-89ed-24c0a3d11ab4",
"name": "illustrator"
},
{
"id": "823e8339-2296-4972-aeed-951df1826228",
"name": "portfolio"
}
],
"createdAt": "2020-08-02T00:34:45.000Z",
"updatedAt": "2020-08-02T00:34:45.000Z"
},
...
]GET /:user/tagsuser: string— user name
http GET 'https://dev.piny.link/:user/tags' \
'Authorization':'Bearer XXX'[
{
"id": "2c00e362-30fc-4dba-89ed-24c0a3d11ab4",
"name": "illustrator"
},
{
"id": "823e8339-2296-4972-aeed-951df1826228",
"name": "portfolio"
}
]POST /bookmarksurl: string— bookmark urltitle?: string— bookmark title (optional)description?: string— bookmark description (optional)privacy: 'public'— access to bookmark (only'public'supported at the moment)tags?: string[]— list of tags that should be assigned to the bookmark, will be added to the user tags (optional)
http --json POST 'https://dev.piny.link/bookmarks' \
'Authorization':'Bearer XXX' \
'Content-Type':'application/json' \
title="KayWay" \
description="Illustration portfolio by Ekaterina Grishina" \
url="https://kayway.me" \
privacy="public" \
tags:="[
\"illustrator\",
\"portfolio\"
]"{
"message": "✨ Created"
}PATCH /bookmarks/:idid: string— bookmark id
url?: string— bookmark url (optional)title?: string— bookmark title (optional)description?: string— bookmark description (optional)privacy?: 'public'— access to bookmark (only'public'supported at the moment) (optional)tags?: string[]— list of tags that should be assigned to the bookmark, will be added to the user tags (optional)
http --json PATCH 'https://dev.piny.link/bookmarks/:id' \
'Authorization':'Bearer XXX' \
'Content-Type':'application/json' \
title="KayWay" \
description="Illustration portfolio by Ekaterina Grishina" \
tags:="[
\"illustrator\",
\"portfolio\"
]"{
"message": "💾 Saved"
}DELETE /bookmarks/:idid: string— bookmark id
http DELETE 'https://dev.piny.link/bookmarks/:id' \
'Authorization':'Bearer XXX'{
"message": "🗑 Removed"
}© Ivan Grishin