Nordpress

Appearance

Highlights ​

當前用戶創建重點操作

掛載功能 ​

  • like/unlike
  • favorite/unfavorite
  • collect

[PUT][AUTH][CURRENT_USER] /api/highlights/:id ​

當前登入用戶更新自己建立的重點。

validation ​

  • content: required, str

request ​

json
{
	"content": "11111"
}

response ​

json
{
	"data": {
		"id": 3,
		"user_id": 1,
		"link_id": 1,
		"content": "11111",
		"created_at": "2024-06-30T14:21:06.000000Z",
		"updated_at": "2024-06-30T14:38:02.000000Z",
		"deleted_at": null
	}
}

[GET][AUTH][CURRENT_USER] /api/highlights/:id/notes ​

取得當前用戶指定的重點筆記清單。

response ​

json
{
	"data": [
		{
			"id": 4,
			"user_id": 1,
			"content": "h11321ello!!",
			"created_at": "2024-06-30T14:40:56.000000Z",
			"updated_at": "2024-06-30T14:40:56.000000Z",
			"deleted_at": null,
			"pivot": {
				"notable_type": "highlight",
				"notable_id": 3,
				"note_id": 4
			}
		}
	],
	"links": {
		"first": "http:\/\/nordpress-next.test\/api\/highlights\/3\/notes?page=1",
		"last": "http:\/\/nordpress-next.test\/api\/highlights\/3\/notes?page=1",
		"prev": null,
		"next": null
	},
	"meta": {
		"current_page": 1,
		"from": 1,
		"last_page": 1,
		"links": [
			{
				"url": null,
				"label": "« Previous",
				"active": false
			},
			{
				"url": "http:\/\/nordpress-next.test\/api\/highlights\/3\/notes?page=1",
				"label": "1",
				"active": true
			},
			{
				"url": null,
				"label": "Next »",
				"active": false
			}
		],
		"path": "http:\/\/nordpress-next.test\/api\/highlights\/3\/notes",
		"per_page": 10,
		"to": 1,
		"total": 1
	}
}

[POST][AUTH][CURRENT_USER] /api/highlights/:id/notes ​

為自己建立的重點新增筆記。

validation ​

  • content: required,str

request ​

json
{
	"content": "h11321ello!!"
}

response ​

json
{
	"data": {
		"user_id": 1,
		"content": "h11321ello!!",
		"updated_at": "2024-06-30T14:42:44.000000Z",
		"created_at": "2024-06-30T14:42:44.000000Z",
		"id": 5,
		"highlight": {
			"id": 3,
			"user_id": 1,
			"link_id": 1,
			"content": "11111",
			"created_at": "2024-06-30T14:21:06.000000Z",
			"updated_at": "2024-06-30T14:38:02.000000Z",
			"deleted_at": null
		}
	},
	"highlight": {
		"id": 3,
		"user_id": 1,
		"link_id": 1,
		"content": "11111",
		"created_at": "2024-06-30T14:21:06.000000Z",
		"updated_at": "2024-06-30T14:38:02.000000Z",
		"deleted_at": null
	}
}

[GET][AUTH][CURRENT_USER] /api/highlights/:id ​

取得當前用戶指定的重點。

response ​

json
{
	"data": {
		"id": 3,
		"user_id": 1,
		"link_id": 1,
		"content": "11111",
		"created_at": "2024-06-30T14:21:06.000000Z",
		"updated_at": "2024-06-30T14:38:02.000000Z",
		"deleted_at": null
	}
}

[DELETE][AUTH][CURRENT_USER] /api/highlights/:id ​

刪除當前用戶指定的重點。

response ​

HTTP_NO_CONTENT = 204

[POST][AUTH][CURRENT_USER] /api/highlights/:id/favorites/toggle ​

當前用戶對指定重點最愛/取消最愛。

response ​

favorite

json
{
	"data": {
		"attached": [
			1
		],
		"detached": [],
		"count": 1
	}
}

unfavorite

json
{
	"data": {
		"attached": [],
		"detached": [
			1
		],
		"count": 0
	}
}

[POST][AUTH][CURRENT_USER] /api/highlights/:id/likes/toggle ​

當前用戶對指定重點點讚/取消點讚。

response ​

like

json
{
	"data": {
		"attached": [
			1
		],
		"detached": [],
		"count": 1
	}
}

unlike

json
{
	"data": {
		"attached": [],
		"detached": [
			1
		],
		"count": 0
	}
}