API docs by Redocly

ZpDIC Online API (0.1.0)

Download OpenAPI specification:

ベース URL

全ての API のベース URL は https://zpdic.ziphil.com/api です。 API を呼ぶ際は、このベース URL の後ろに該当 API のパスを繋げたものにリクエストを送ってください。

認証

Web サイト上で API キーを取得して、X-Api-Key ヘッダーに設定してください。 API キーが正しく設定されていない場合は、401 エラーが返されます。

型に関する注意

この API で扱われる辞書や例文のデータの型は、ZpDIC Online 内部で用いられているものと近い形になっています。 そのため、OTM-JSON 形式での型と異なる点がいくつかあります。 あらかじめ該当 API のドキュメントを参照して、正しい型情報を確認しておいてください。

必須項目

プロパティ名に required と書かれているプロパティは必須です。 リクエストに必須プロパティが含まれていない場合は、400 エラーが返されます。 ネストしているプロパティが必須になっていることもあるので、注意してください。

なお必須プロパティは、そのプロパティの存在が必須であるだけなので、そこにゼロ値を指定することはできます。 例えば、文字列型の必須プロパティに空文字列を指定することは可能です。

プロパティ名に required と書かれていないプロパティは省略可能です。 その場合は、付記されているデフォルト値が指定されたものと見なされます。

単語

辞書の単語を検索する

Authorizations:
apiKeyAuth
path Parameters
identifier
required
string

辞書の番号もしくは URL 用識別子

query Parameters
text
required
string

検索する文字列

mode
string
Default: "both"
Enum: "name" "equivalent" "both" "tag" "information" "variation" "relation" "content"

検索範囲

  • "name" — 単語
  • "equivalent" — 訳語
  • "both" — 単語＋訳語
  • "tag" — タグ
  • "information" — 内容
  • "variation" — 変化形
  • "relation" — 関連語
  • "content" — 全文
type
string
Default: "prefix"
Enum: "exact" "prefix" "suffix" "part" "regular"

検索方法

  • "exact" — 完全一致
  • "prefix" — 前方一致
  • "suffix" — 後方一致
  • "part" — 部分一致
  • "regular" — 正規表現
orderMode
string
Default: "unicode"
Enum: "unicode" "updatedDate" "createdDate"

ソート順

  • "unicode" — 綴りの文字コード順
  • "updatedDate" — 更新日時順
  • "createdDate" — 作成日時順
orderDirection
string
Default: "ascending"
Enum: "ascending" "descending"

ソート方向

  • "ascending" — 昇順
  • "descending" — 降順
ignoreCase
boolean
Default: false

大小文字の違いを無視するかどうか

skip
integer >= 0
Default: 0

ページング用スキップ件数

limit
integer [ 1 .. 100 ]
Default: 100

ページング用返却件数

Responses

Response samples

Content type
application/json
{
  • "words": [
    ],
  • "total": 250
}

辞書に単語を新しく作成する

Authorizations:
apiKeyAuth
path Parameters
identifier
required
string

辞書の番号もしくは URL 用識別子

Request Body schema: application/json
required
object (EditableWord)

Responses

Request samples

Content type
application/json
{
  • "word": {
    }
}

Response samples

Content type
application/json
{
  • "word": {
    }
}

辞書の単語を取得する (1 件)

Authorizations:
apiKeyAuth
path Parameters
identifier
required
string

辞書の番号もしくは URL 用識別子

wordNumber
required
integer

単語の番号

Responses

Response samples

Content type
application/json
{
  • "word": {
    }
}

辞書の単語を編集する

Authorizations:
apiKeyAuth
path Parameters
identifier
required
string

辞書の番号もしくは URL 用識別子

wordNumber
required
integer

単語の番号

Request Body schema: application/json
required
object (EditableWord)

Responses

Request samples

Content type
application/json
{
  • "word": {
    }
}

Response samples

Content type
application/json
{
  • "word": {
    }
}

辞書の単語を削除する

Authorizations:
apiKeyAuth
path Parameters
identifier
required
string

辞書の番号もしくは URL 用識別子

wordNumber
required
integer

単語の番号

Responses

Response samples

Content type
application/json
{
  • "word": {
    }
}

例文

辞書の例文を検索する

Authorizations:
apiKeyAuth
path Parameters
identifier
required
string

辞書の番号もしくは URL 用識別子

query Parameters
text
required
string

検索する文字列

mode
string
Default: "both"
Enum: "sentence" "translation" "both" "tag" "content"

検索範囲

  • "sentence" — 例文
  • "translation" — 訳文
  • "both" — 例文＋訳文
  • "tag" — タグ
  • "content" — 全文
type
string
Default: "prefix"
Enum: "exact" "prefix" "suffix" "part" "regular"

検索方法

  • "exact" — 完全一致
  • "prefix" — 前方一致
  • "suffix" — 後方一致
  • "part" — 部分一致
  • "regular" — 正規表現
ignoreCase
boolean
Default: false

大小文字の違いを無視するかどうか

skip
integer >= 0
Default: 0

ページング用スキップ件数

limit
integer [ 1 .. 100 ]
Default: 100

ページング用返却件数

Responses

Response samples

Content type
application/json
{
  • "examples": [
    ],
  • "total": 250
}

辞書に例文を新しく作成する

Authorizations:
apiKeyAuth
path Parameters
identifier
required
string

辞書の番号もしくは URL 用識別子

Request Body schema: application/json
required
object (EditableExample)

Responses

Request samples

Content type
application/json
{
  • "example": {
    }
}

Response samples

Content type
application/json
{
  • "example": {
    }
}

辞書の例文を取得する (1 件)

Authorizations:
apiKeyAuth
path Parameters
identifier
required
string

辞書の番号もしくは URL 用識別子

exampleNumber
required
integer

例文の番号

Responses

Response samples

Content type
application/json
{
  • "example": {
    }
}

辞書の例文を編集する

Authorizations:
apiKeyAuth
path Parameters
identifier
required
string

辞書の番号もしくは URL 用識別子

exampleNumber
required
integer

例文の番号

Request Body schema: application/json
required
object (EditableExample)

Responses

Request samples

Content type
application/json
{
  • "example": {
    }
}

Response samples

Content type
application/json
{
  • "example": {
    }
}

辞書の例文を削除する

Authorizations:
apiKeyAuth
path Parameters
identifier
required
string

辞書の番号もしくは URL 用識別子

exampleNumber
required
integer

例文の番号

Responses

Response samples

Content type
application/json
{
  • "example": {
    }
}

例文集

例文集の例文を検索する

Authorizations:
apiKeyAuth
query Parameters
catalog
required
string

例文集名

  • "zpdicDaily" — 今日の例文
  • "appleAlpha" — リンゴを食べたい 58 文
  • "appleBeta" — リンゴを食べ足りない 57 文
  • "appleGamma" — リンゴをもっと食べたい 55 文
  • "survival" — 今日を生き抜く実用例文
  • "weaving" — 手袋と辞書を編む 50 文
skip
integer >= 0
Default: 0

ページング用スキップ件数

limit
integer [ 1 .. 100 ]
Default: 100

ページング用返却件数

Responses

Response samples

Content type
application/json
{
  • "exampleOffers": [
    ],
  • "total": 250
}

例文集の例文を取得する (1 件)

Authorizations:
apiKeyAuth
path Parameters
catalog
required
string

例文集名

  • "zpdicDaily" — 今日の例文
  • "appleAlpha" — リンゴを食べたい 58 文
  • "appleBeta" — リンゴを食べ足りない 57 文
  • "appleGamma" — リンゴをもっと食べたい 55 文
  • "survival" — 今日を生き抜く実用例文
  • "weaving" — 手袋と辞書を編む 50 文
exampleOfferNumber
required
integer

例文集の例文の番号

Responses

Response samples

Content type
application/json
{
  • "exampleOffer": {
    }
}