青空文庫 RevisedのJSON API

青空文庫 Revised に JSON で値を取得できる API を組込みました。

  • 値を取得する API しか存在しません
  • パラメーターはGET METHODでURLエンコードして指定する
  • 文字エンコーディングは UTF-8 とする

作品に関するAPI

/api/v1/works/<workId>

ベースURL: http://aozora.textlive.net/api/v1/works/<workId>

例: http://aozora.textlive.net/api/v1/works/57342

取得されるJSON:

リソース名 タイプ 説明
error 数字 0 以外は異常
message 文字列 オプショナル エラーの内容を表す文字列
workId 数字 作品ID
responsibility 文字列 責任表示
title 文字列 作品名
titleTranscription 文字列 作品名読み
subTitle 文字列 オプショナル サブタイトル
subTitleTranscription 文字列 オプショナル サブタイトル読み
originalTitle 文字列 オプショナル 原題
authors オブジェクト author1
copyrightFlag 文字列 “あり” / “なし”
files オブジェクト file2
href 文字列 作品固有のJSONデータを指すURL
firstPublish 文字列 オプショナル 初出
mojitsukai 文字列 文字使い
publicDate 日付 公開日
updated 日付 テキストファイル最終更新日

/api/v1/works

ベースURL: http://aozora.textlive.net/api/v1/works

例: http://aozora.textlive.net/api/v1/works?title=%E6%B0%B4&order=title&offset=1

指定できるクエリパラメータ:

リソース名 内容
limit 1回で取得できる件数 1 〜 50
offset limit * offset 件目から取得   0 〜
order updated / uipdatedDesc / title / titleDesc
title 作品名 部分一致 titleExactly と同時指定不可
titleExactly 作品名 完全一致 title と同時指定不可
author 人物名 部分一致 authorExactly と authorId と同時指定不可
authorExactly 人物名 完全一致 author と authorId と同時指定不可
authorId 人物ID author と authorExactly と同時指定不可

取得されるJSON:

リソース名 タイプ 説明
error 数字 0 以外は異常
message 文字列 オプショナル エラーの内容を表す文字列
prev 文字列 オプショナル 前の件のURL
next 文字列 オプショナル 次の件のURL
totalCount 数字 指定条件の件数
entries オブジェクト work3

人物に関するAPI

/api/v1/authors/<authorId>

ベースURL: http://aozora.textlive.net/api/v1/authors/<authorId>

例: http://aozora.textlive.net/api/v1/authors/14

取得されるJSON:

リソース名 タイプ 説明
error 数字 0 以外は異常
message 文字列 オプショナル エラーの内容を表す文字列
authorId 数字 人物ID
name 文字列 姓名
nameAlternative 文字列 姓名 ローマ字
nameTranscription 文字列 姓名 読み
firstName 文字列
firstNameAlternative 文字列 名 ローマ字
firstNameTranscription 文字列 名 読み
lastName 文字列
lastNameAlternative 文字列 姓 ローマ字
lastNameTranscription 文字列 姓 読み

/api/v1/authors

ベースURL: http://aozora.textlive.net/api/v1/authors

例: http://aozora.textlive.net/api/v1/authors?author=%E5%B7%9D

指定できるクエリパラメータ:

リソース名 内容
limit 1回で取得できる件数 1 〜 50
offset limit * offset 件目から取得   0 〜
order author / authorDesc
author 人物名 部分一致 authorExactly と authorId と同時指定不可
authorExactly 人物名 完全一致 author と authorId と同時指定不可
authorId 人物ID author と authorExactly と同時指定不可

取得されるJSON:

リソース名 タイプ 説明
error 数字 0 以外は異常
message 文字列 オプショナル エラーの内容を表す文字列
prev 文字列 オプショナル 前の件のURL
next 文字列 オプショナル 次の件のURL
totalCount 数字 指定条件の件数
entries オブジェクト author1

  1. author

    リソース名 タイプ 説明
    authorId 数字 人物ID
    name 文字列 姓名
    nameAlternative 文字列 姓名 ローマ字
    nameTranscription 文字列 姓名 読み
    firstName 文字列
    firstNameAlternative 文字列 名 ローマ字
    firstNameTranscription 文字列 名 読み
    lastName 文字列
    lastNameAlternative 文字列 姓 ローマ字
    lastNameTranscription 文字列 姓 読み
    role 文字列 オプショナル “著者” / “翻訳者” 等

     

  2. file

    リソース名 タイプ 説明
    href 文字列 当該ファイルのURL
    description 文字列 ファイルの種類

     

  3. work

    リソース名 タイプ 説明
    workId 数字 作品ID
    responsibility 文字列 責任表示
    title 文字列 作品名
    titleTranscription 文字列 作品名読み
    subTitle 文字列 オプショナル サブタイトル
    subTitleTranscription 文字列 オプショナル サブタイトル読み
    originalTitle 文字列 オプショナル 原題
    authors オブジェクト author[^1]
    copyrightFlag 文字列 著作権残存 “あり” / “なし”
    files オブジェクト file[^2]
    href 文字列 作品固有のJSONデータを指すURL
    firstPublish 文字列 オプショナル 初出
    mojitsukai 文字列 文字使い
    publicDate 日付 公開日
    updated 日付 テキストファイル最終更新日