sana_server

KO | EN

gitlite — search

#python #hacktoberfest #react #llm #machine-learning #linux #macos #windows #kubernetes #awesome-list #security #ios #mcp #openai

(★ 12)

ShangriLa API Server. Response Twitter Data

sana_server Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

#Sana 紗凪
ShangriLa Anime API Server for Twitter Data

## Sana Server システム概要

### 説明

* アニメに関するTwitterのデータを返すREST形式のAPIサーバーのリファレンス実装です。
* ShangriLa Anime API のサブセットです。

### サーバーシステム要件

* Ruby 2.2+
* フレームワーク Sinatra

### インストール

#### DB
* MySQL、もしくはMySQL互換サーバーのインストール
* anime_admin_development データベース作成
* 必要なDDLの投入 [shangriLa](https://github.com/Project-ShangriLa/shangrila)

#### sana batch

* 実際にTwitterのデータを取り扱うにはTwitterから定期的にデータを取得するバッチを実行する必要があります

### DB接続設定

```
export SANA_DB_HOST=""
export SANA_DB_USER=""
export SANA_DB_PASSWORD=""
```

#### API Server

```
bundle install
```

### 起動方法-開発

```
bundle exec ruby sana_api.rb
```

```
bundle exec rerun ruby sana_api.rb
```

```
bundle exec unicorn -c unicorn.rb
```

### 起動方法-本番

```
bundle exec unicorn -c unicorn.rb -D -E production
```
-D デーモン化
-E production

デーモン化した後の再起動

```
kill -HUP `cat /tmp/unicorn_sana.pid`
```

## V1 API リファレンス

### エンドポイント

http://api.moemoe.tokyo/anime/v1

### 認証

V1では認証を行いません。

### レートリミット

なし

### GET /anime/v1/twitter/follower/status

リクエストで指定されたアニメ公式アカウントの最新のフォロワー数を返却します

#### Request Parameter

| Property     | Value               |description|Sample|
| :------------ | :------------------ |:--------|:-------|
| accounts    |String|対象のTwitterアカウントをカンマ区切りにしたもの|usagi_anime,kinmosa_anime|

#### Response Body

| Property     | Value               |description|Sample|
| :------------ | :------------------ |:--------|:-------|
| Request twitter_account 1|follower Object||"usagi_anime": {..}|
| Request twitter_account 2|follower Object||"kinmosa_anime": {..}|
| Request twitter_account X|follower Object||"lovelive_staff": {..}|

##### follower Object

| Property     | Value               |description|Sample|
| :------------ | :------------------ |:--------|:-------|
| follower    |Number|フォロワー数|12500|
| updated_at   |Number|データの更新日時 UNIX TIMESTAMP|1446132941|

#### レスポンス例

```
curl -v http://api.moemoe.tokyo/anime/v1/twitter/follower/status?accounts=usagi_anime,kinmosa_anime,aldnoahzero | jq .
```

```json
{
  "aldnoahzero": {
    "updated_at": 1432364949,
    "follower": 51055
  },
  "usagi_anime": {
    "updated_at": 1411466007,
    "follower": 51345
  },
  "kinmosa_anime": {
    "updated_at": 1432364961,
    "follower": 57350
  }
}
```

### GET /anime/v1/twitter/follower/history

リクエストで指定されたアニメ公式アカウントのフォロワー数の履歴を返却します。（最大100履歴）

#### Request Parameter

| Property     |Value |Required|description|Sample|
| :------------|:-----|:-------|:----------|:-----|
| account    |String|◯|対象のTwitterアカウント|usagi_anime|
| end_date |Number|-|unixtimestampで指定した日時より過去のデータを取得。指定がない場合は現在日時。 where updated_at < end_date |1446132941|

#### Response Body

| Property     | Value               |description|Sample|
| :------------ | :------------------ |:--------|:-------|
| Array Object|history Object Array|取得できない場合は空の配列|[]|

##### history Object

データは更新日時の降順でソートされ格納されています。

#### レスポンス例1

```
curl -v http://api.moemoe.tokyo/anime/v1/twitter/follower/history?account=usagi_anime | jq .
```

```json
[
  {
    "updated_at": 1411466007,
    "follower": 51345
  },
  {
    "updated_at": 1410674102,
    "follower": 50606
  },
  {
    "updated_at": 1410673804,
    "follower": 50607
  },
  {
    "updated_at": 1407743045,
    "follower": 46350
  }
]
```

#### レスポンス例2

```
curl "http://api.moemoe.tokyo/anime/v1/twitter/follower/history?account=usagi_anime&end_date=1407562541" | jq .
```

```json
[
  {
    "updated_at": 1407560663,
    "follower": 46165
  },
  {
    "updated_at": 1407558786,
    "follower": 46166
  },
  {
    "updated_at": 1407556908,
    "follower": 46162
  }
]
```

### GET /anime/v1/twitter/follower/history/daily

リクエストで指定されたアニメ公式アカウントのフォロワー数の履歴を日付単位で返却します。(最大30日）

クライアント側でデータ加工が難しい場合(JavaScriptなど)はこちらのAPIを使用してください。

#### Request Parameter

| Property     |Value |Required|description|Sample|
| :------------|:-----|:-------|:----------|:-----|
| account    |String|◯|対象のTwitterアカウント|usagi_anime|
| days |Number|-|現在から何日前までのデータを取得したいかを指定(無指定の場合7日間)|30|

※daysが30を超えた値の場合は自動的に7が割り当てられます

#### Response Body

| Property     | Value               |description|Sample|
| :------------ | :------------------ |:--------|:-------|
| Array Object|history Object Array|取得できない場合は空の配列|[]|

##### history Object

データは更新日時の「昇順」でソートされ格納されています。

#### レスポンス例1

```
curl -v "http://api.moemoe.tokyo/anime/v1/twitter/follower/history/daily?account=usagi_anime"| jq .
```

```json
[
  {
    "follower": 153113,
    "updated_at": 1452352632,
    "yyyy-mm-dd": "2016-01-10"
  },
  {
    "follower": 153413,
    "updated_at": 1452441190,
    "yyyy-mm-dd": "2016-01-11"
  },
  {
    "follower": 153722,
    "updated_at": 1452526159,
    "yyyy-mm-dd": "2016-01-12"
  },
  {
    "follower": 153885,
    "updated_at": 1452611123,
    "yyyy-mm-dd": "2016-01-13"
  },
  {
    "follower": 153996,
    "updated_at": 1452699620,
    "yyyy-mm-dd": "2016-01-14"
  },
  {
    "follower": 154087,
    "updated_at": 1452784577,
    "yyyy-mm-dd": "2016-01-15"
  },
  {
    "follower": 154194,
    "updated_at": 1452873102,
    "yyyy-mm-dd": "2016-01-16"
  }
]
```

#### レスポンス例2

```
curl "http://api.moemoe.tokyo/anime/v1/twitter/follower/history/daily?account=usagi_anime&days=10" | jq .
```

```json
[
  {
    "follower": 152159,
    "updated_at": 1452094248,
    "yyyy-mm-dd": "2016-01-07"
  },
  {
    "follower": 152321,
    "updated_at": 1452179172,
    "yyyy-mm-dd": "2016-01-08"
  },
  {
    "follower": 152796,
    "updated_at": 1452267687,
    "yyyy-mm-dd": "2016-01-09"
  },
  {
    "follower": 153113,
    "updated_at": 1452352632,
    "yyyy-mm-dd": "2016-01-10"
  },
  {
    "follower": 153413,
    "updated_at": 1452441190,
    "yyyy-mm-dd": "2016-01-11"
  },
  {
    "follower": 153722,
    "updated_at": 1452526159,
    "yyyy-mm-dd": "2016-01-12"
  },
  {
    "follower": 153885,
    "updated_at": 1452611123,
    "yyyy-mm-dd": "2016-01-13"
  },
  {
    "follower": 153996,
    "updated_at": 1452699620,
    "yyyy-mm-dd": "2016-01-14"
  },
  {
    "follower": 154087,
    "updated_at": 1452784577,
    "yyyy-mm-dd": "2016-01-15"
  },
  {
    "follower": 154194,
    "updated_at": 1452873102,
    "yyyy-mm-dd": "2016-01-16"
  }
]
```

sana_server

sana_server Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

sana_server

sana_server Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README