📐 住所のスキーマ

住所のスキーマは、厳格な再利用可能な住所フラグメントと住所検索エンドポイントへのクエリコントラクトを提供します。

インベントリ

エクスポート	リクエスト場所	コントラクト
address	N/A	省略可能な文字列の住所行の配列
postalCode	N/A	省略可能な文字列の郵便番号
prefecture	N/A	省略可能な文字列または null の都道府県
city	N/A	省略可能な文字列の市区
country	N/A	省略可能な文字列の国名
addressJPSchema	N/A	省略可能な日本語の住所コンポーネント
partialPostalCodeQueryParameter	クエリ	必須の半分または完全な日本の郵便番号
findAddressSchema	クエリ	検索リクエストスキーマ

詳細

address

定義

address は必須フィールドのない厳格なオブジェクトです。

場所	フィールド	型	必須	コントラクト
N/A	address	string[]	いいえ	全ての配列アイテムが文字列

additionalProperties は false です。

ルートで使用: 直接使用なし。機能で使用: 直接使用なし。

完全なソースを表示

export const address: SchemaDefinition = {
  $schema: 'http://json-schema.org/draft-07/schema#',
  additionalProperties: false,
  properties: {address: {items: {type: 'string'}, type: 'array'}},
  type: 'object',
};

---

postalCode

定義

場所	フィールド	型	必須	コントラクト
N/A	postalCode	string	いいえ	パターンは適用されない

additionalProperties は false です。

ルートで使用: 直接使用なし。機能で使用: 直接使用なし。

完全なソースを表示

export const postalCode: SchemaDefinition = {
  $schema: 'http://json-schema.org/draft-07/schema#',
  additionalProperties: false,
  properties: {postalCode: {type: 'string'}},
  type: 'object',
};

---

prefecture

定義

場所	フィールド	型	必須	コントラクト
prefecture	N/A	string | null	いいえ	Nullが受理される

additionalProperties は false です。

ルートで使用: 直接使用なし。機能で使用: 直接使用なし。

完全なソースを表示

export const prefecture: SchemaDefinition = {
  $schema: 'http://json-schema.org/draft-07/schema#',
  additionalProperties: false,
  properties: {prefecture: {type: ['string', 'null']}},
  type: 'object',
};

---

city

定義

場所	フィールド	型	必須	コントラクト
N/A	city	string	いいえ	市区名

additionalProperties は false です。

ルートで使用: 直接使用なし。機能で使用: 直接使用なし。

完全なソースを表示

export const city: SchemaDefinition = {
  $schema: 'http://json-schema.org/draft-07/schema#',
  additionalProperties: false,
  properties: {city: {type: 'string'}},
  type: 'object',
};

---

country

定義

場所	フィールド	型	必須	コントラクト
N/A	country	string	いいえ	国名

additionalProperties は false です。

ルートで使用: 直接使用なし。機能で使用: 直接使用なし。

完全なソースを表示

export const country: SchemaDefinition = {
  $schema: 'http://json-schema.org/draft-07/schema#',
  additionalProperties: false,
  properties: {country: {type: 'string'}},
  type: 'object',
};

---

addressJPSchema

定義

場所	フィールド	型	必須	コントラクト
N/A	city	string	いいえ	市区名
N/A	country	string	いいえ	国名
N/A	postalCode	string	いいえ	郵便番号
N/A	prefecture	string	いいえ	都道府県名
N/A	street	string	いいえ	番地

additionalProperties は false です。このスキーマには必須フィールドはありません。

ルートで使用: 直接使用なし。機能で使用: 直接使用なし。

完全なソースを表示

export const addressJPSchema: SchemaDefinition = {
  $schema: 'http://json-schema.org/draft-07/schema#',
  additionalProperties: false,
  properties: {
    city: {type: 'string'},
    country: {type: 'string'},
    postalCode: {type: 'string'},
    prefecture: {type: 'string'},
    street: {type: 'string'},
  },
  type: 'object',
};

---

partialPostalCodeQueryParameter

定義

場所	フィールド	型	必須	コントラクト
クエリ	postalCode	string	はい	^\d{3}-?\d{0,4}$ に一致

findAddressSchema によって展開。ルートで使用: findAddressRoute。機能で使用: findAddressFeature。

完全なソースを表示

export const partialPostalCodeQueryParameter: OpenAPIParameter = {
  in: 'query',
  name: 'postalCode',
  required: true,
  schema: {pattern: '^\\d{3}-?\\d{0,4}$', type: 'string'},
};

---

findAddressSchema

定義

必須の postalCode クエリパラメータを使用します。

場所	フィールド	型	必須	コントラクト
クエリ	postalCode	string	はい	^\d{3}-?\d{0,4}$ に一致；3桁の数字、省略可能なハイフン、0〜4桁の追加数字を受け付ける

ルートで使用: findAddressRoute。機能で使用: findAddressFeature。

完全なソースを表示

export const findAddressSchema = withSchema({
  parameters: [partialPostalCodeQueryParameter],
});

---