---
# System prepended metadata

title: Signet 仕様

---

# Signet 仕様

# JSON

## /api/signet

### GET

```図1.md=1
{
  "signets": [
    {
      // DB内で一意に定められるID
      "signet_id": 42,
      // 保存されたWebページのURL
      "url": "https://www.tokuyama.ac.jp/",
      // 保存されたWebページのアイコンのURL
      "icon": "https://www.tokuyama.ac.jp/icon.ico",
      // 保存されたWebページのtitle要素
      "title": "徳山工業高等専門学校",
      // 保存されたWebページに対するコメント
      "comment": "徳山高専のホームページのトップページ",
      // 保存されたWebページのすでに読み終わっている高さ
      "position": 1200,
      // 保存された日時
      "created_at": "2020-01-16 05:32:47.552817"
    },
    ...  // DBに保存されている全てのデータを返す
  ]
}
```

### POST

```図2.md=1
{
  // 保存したいWebページのURL
  "url": "https://www.tokuyama.ac.jp/",
  // 保存されたWebページのアイコンのURL
  "icon": "https://www.tokuyama.ac.jp/icon.ico",
  // 保存されたWebページのtitle要素
  "title": "徳山工業高等専門学校",
  // 保存時にすでに読み終わっているWebページの高さ
  "position": 1200
}
```

### DELETE

```図3.md=1
{
  // 一覧から削除したいWebページのID
  "signet_id": 42
}
```

## /api/signet/comment

### POST

```md=1
{
  // コメントを編集したいid
  "signet_id": 42,
  // Webページに対するコメント
  "comment": "徳山高専のホームページのトップページ"
}
```

# テスト要綱

* データの一覧の取得 -> Webページに飛べるか確認
* しおりの登録
* しおりの削除
* コメントの編集
