www_aozora_gr_jp.raml

#%RAML 0.8
title: 青空文庫Webサーバ
baseUri: http://www.aozora.gr.jp
version: v1.0
mediaType: text/html

/index_pages:
  /index_top.html#public_list:
    get:
      description: 総合インデックス・公開中の作品
  /index_top.html#work_list:
    get:
      description: 総合インデックス・作業中の作品
  /index_all.html:
    get:
      description: 登録全作家インデックス

  /person_all.html:
    get:
      description: 公開中　作家リスト：全て
  /person_inp_all.html:
    get:
      description: 作業中　作家リスト：全て
  /person_all_all.html:
    get:
      description: 登録全作家　作家リスト：全て

  /person_{personFirstchar}.html#{personFirstcharSec}:
    uriParameters:
      personFirstchar:
        displayName: Person FirstChar
        type: string
        pattern: ^([kstnhmyrw]?a|zz)$
      personFirstcharSec:
        displayName: Person FirstChar section
        type: string
        pattern: ^sec[12345]$
    get:
      description: 公開中　作家リスト：{personFirstchar}行 / {personFirstcharSec}
  /person_inp_{personFirstchar}.html#{personFirstcharSec}:
    get:
      description: 作業中　作家リスト：{personFirstchar}行 / {personFirstcharSec}
  /person_all_{personFirstchar}.html#{personFirstcharSec}:
    get:
      description: 登録全作家　作家リスト：{personFirstchar}行 / {personFirstcharSec}

  /person{personId}.html:
    uriParameters:
      personId:
        displayName: Person ID
        type: integer
        minimum: 1
        maximum: 999999
    get:
      description: 作家別作品リスト：No.{personId}

  /list_person_all.zip:
    get:
      description: 公開中　作家別作品一覧：全て(CSV形式、zip圧縮）
  /list_person_all_extended.zip:
    get:
      description: 公開中　作家別作品一覧拡充版：全て(CSV形式、zip圧縮）
  /list_person_all_utf8.zip:
    get:
      description: 公開中　作家別作品一覧：全て(CSV形式、UTF-8、zip圧縮）
  /list_person_all_extended_utf8.zip:
    get:
      description: 公開中　作家別作品一覧拡充版：全て(CSV形式、UTF-8、zip圧縮）


/cards:
  /{personIdNNNNNN}:
    uriParameters:
      personIdNNNNNN:
        displayName: Person ID (6digits)
        type: string
        pattern: ^([0-9][0-9][0-9][0-9][0-9][0-9])$
    /card{bookId}.html:
      uriParameters:
        bookId:
          displayName: Book ID
          type: integer
          minimum: 1
      get:
        description: 図書カード：No.{bookId}

    /files:
      /{bookId}_ruby_{bookFormatId}.zip:
        uriParameters:
          bookId:
            displayName: Book ID
            type: integer
          bookFormatId:
            displayName: Book Format ID
            type: integer
            minimum: 1
        get:
          description: 作品(テキスト・ルビあり)
      /{bookId}_txt_{bookFormatId}.zip:
        get:
          description: 作品(テキスト・ルビなし)
      /{bookId}_{bookFormatId}.html:
        get:
          description: 作品(HTML)
      /{bookId}.ebk:
        get:
          description: 作品(エキスパンドブック)