Last active
March 29, 2018 10:15
-
-
Save schon/da151b69d7ede4f4ed3d81d7668fad9b to your computer and use it in GitHub Desktop.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
--- | |
swagger: "2.0" | |
info: | |
version: "2018-03-29T10:08:28Z" | |
title: "ChintAISearch" | |
host: "p9s9218kij.execute-api.ap-northeast-1.amazonaws.com" | |
basePath: "/dev" | |
schemes: | |
- "https" | |
paths: | |
/chintai/search: | |
get: | |
description: "物件検索API" | |
produces: | |
- "application/json" | |
parameters: | |
- name: "year" | |
in: "query" | |
description: "築年数" | |
required: true | |
type: "string" | |
- name: "points" | |
in: "query" | |
description: "polygon検索時の緯度経度情報を'|'区切りで繋げたもの。例)35.713768,139.777254|35.665498,139.75964|35.630152,139.74044" | |
required: false | |
type: "string" | |
- name: "madori" | |
in: "query" | |
description: "間取り。カンマ区切りで複数指定可(例:'ワンルーム', '2LDK', '1DK,1LDK')" | |
required: false | |
type: "string" | |
- name: "type" | |
in: "query" | |
description: "物件タイプ(マンション、アパート等)" | |
required: false | |
type: "string" | |
- name: "geometry" | |
in: "query" | |
description: "GEO検索種類(例:polygon)" | |
required: false | |
type: "string" | |
- name: "space" | |
in: "query" | |
description: "広さ(平米)" | |
required: true | |
type: "string" | |
- name: "cost" | |
in: "query" | |
description: "コスト(万円/月)" | |
required: true | |
type: "string" | |
- name: "dstation" | |
in: "query" | |
description: "通勤・通学先の最寄駅名。カンマ区切りで複数指定可" | |
required: true | |
type: "string" | |
- name: "ostation" | |
in: "query" | |
description: "お住いの最寄駅名" | |
required: true | |
type: "string" | |
- name: "size" | |
in: "query" | |
description: "検索件数" | |
required: false | |
type: "string" | |
responses: | |
200: | |
description: "200 response" | |
schema: | |
$ref: "#/definitions/ChintaiSearchResults" | |
headers: | |
Access-Control-Allow-Origin: | |
type: "string" | |
Access-Control-Allow-Methods: | |
type: "string" | |
Access-Control-Allow-Headers: | |
type: "string" | |
security: | |
- api_key: [] | |
options: | |
consumes: | |
- "application/json" | |
produces: | |
- "application/json" | |
responses: | |
200: | |
description: "200 response" | |
schema: | |
$ref: "#/definitions/Empty" | |
headers: | |
Access-Control-Allow-Origin: | |
type: "string" | |
Access-Control-Allow-Methods: | |
type: "string" | |
Access-Control-Allow-Headers: | |
type: "string" | |
/station/search: | |
get: | |
description: "駅名から駅検索API" | |
produces: | |
- "application/json" | |
parameters: | |
- name: "name" | |
in: "query" | |
description: "検索する駅名(部分一致検索可能)" | |
required: true | |
type: "string" | |
responses: | |
200: | |
description: "200 response" | |
schema: | |
$ref: "#/definitions/StationSearchResults" | |
headers: | |
Access-Control-Allow-Origin: | |
type: "string" | |
Access-Control-Allow-Methods: | |
type: "string" | |
Access-Control-Allow-Headers: | |
type: "string" | |
security: | |
- api_key: [] | |
options: | |
consumes: | |
- "application/json" | |
produces: | |
- "application/json" | |
responses: | |
200: | |
description: "200 response" | |
schema: | |
$ref: "#/definitions/Empty" | |
headers: | |
Access-Control-Allow-Origin: | |
type: "string" | |
Access-Control-Allow-Methods: | |
type: "string" | |
Access-Control-Allow-Headers: | |
type: "string" | |
securityDefinitions: | |
api_key: | |
type: "apiKey" | |
name: "x-api-key" | |
in: "header" | |
definitions: | |
Empty: | |
type: "object" | |
title: "Empty Schema" | |
ChintaiSearchResults: | |
type: "object" | |
properties: | |
status: | |
type: "integer" | |
total: | |
type: "integer" | |
hits: | |
type: "integer" | |
results: | |
type: "array" | |
items: | |
type: "object" | |
properties: | |
_id: | |
type: "string" | |
_score: | |
type: "number" | |
type: | |
type: "string" | |
name: | |
type: "string" | |
cost: | |
type: "number" | |
space: | |
type: "number" | |
year: | |
type: "integer" | |
message: | |
type: "string" | |
found: | |
type: "boolean" | |
title: "Chintai Search Results Schema" | |
description: "賃貸物件検索結果モデル" | |
StationSearchResults: | |
type: "object" | |
properties: | |
status: | |
type: "integer" | |
total: | |
type: "integer" | |
results: | |
type: "array" | |
items: | |
type: "object" | |
properties: | |
_id: | |
type: "string" | |
pref_id: | |
type: "integer" | |
pref_name: | |
type: "string" | |
name: | |
type: "string" | |
name_kana: | |
type: "string" | |
message: | |
type: "string" | |
found: | |
type: "boolean" | |
title: "Station Search Results Schema" | |
description: "駅検索結果モデル" |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment