Last active
December 28, 2017 15:39
-
-
Save eit/7aaa2da38ad6c09575c57c420ce7e255 to your computer and use it in GitHub Desktop.
swagger.json for swagger-ui
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": "v1", | |
| "title": "4-axis aircraft control and plug-in module QDB dedicated api", | |
| "description": "Used for four-axis aircraft and plug-in QDB module, through the network to command drone flight, and control QDB module such as delivery and other actions to meet the needs of drone missions" | |
| }, | |
| "tags": [ { | |
| "name" : "api", | |
| "description" : "4-axis aircraft control api" | |
| },{ | |
| "name" : "qdb", | |
| "description" : "qdb module control api" | |
| } ], | |
| "host": "drone.kong.srm.pw", | |
| "schemes": [ | |
| "https" | |
| ], | |
| "basePath": "/drone", | |
| "paths": { | |
| "/api/takeoff/{device_id}": { | |
| "post": { | |
| "tags": [ | |
| "api" | |
| ], | |
| "summary":"used to command a drone to take off", | |
| "description":"Release the takeoff command to the drone", | |
| "operationId": "", | |
| "consumes": [], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters":[{ | |
| "name" : "device_id", | |
| "in" : "path", | |
| "description" : "device id", | |
| "required" : true, | |
| "type" : "string" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/apiResults" | |
| } | |
| } | |
| }, | |
| "deprecated": false | |
| } | |
| }, | |
| "/qdb/dropon.do": { | |
| "get": { | |
| "tags": [ | |
| "qdb" | |
| ], | |
| "summary":"for air drop function of QDB module", | |
| "description":"This function is used to control the opening / closing of the drop device", | |
| "operationId": "", | |
| "consumes": [], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/results" | |
| } | |
| } | |
| }, | |
| "deprecated": false | |
| } | |
| } | |
| }, | |
| "definitions": { | |
| "apiResults": { | |
| "type": "object", | |
| "properties": { | |
| "result": { | |
| "type": "boolean" | |
| }, | |
| "msg": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "results": { | |
| "type": "object", | |
| "properties": { | |
| "result": { | |
| "type": "boolean" | |
| }, | |
| "msg": { | |
| "type": "string" | |
| }, | |
| "value": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } |
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": "v1", | |
| "title": "四軸飛行器控制與外掛模組QDB專用api", | |
| "description": "用於四軸飛行器與外掛QDB模組，透過連網方式來命令無人機飛行，以及控制QDB模組如投放等動作，以滿足無人機飛航任務之需求" | |
| }, | |
| "tags": [ { | |
| "name" : "api", | |
| "description" : "四軸飛行器控制專用api" | |
| },{ | |
| "name" : "qdb", | |
| "description" : "四軸飛行器外掛模組QDB專用api" | |
| } ], | |
| "host": "drone.kong.srm.pw", | |
| "schemes": [ | |
| "https" | |
| ], | |
| "basePath": "/drone", | |
| "paths": { | |
| "/api/takeoff/{device_id}": { | |
| "post": { | |
| "tags": [ | |
| "api" | |
| ], | |
| "summary":"用於命令無人機一鍵起飛", | |
| "description":"下達起飛指令於無人機之用", | |
| "operationId": "", | |
| "consumes": [], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters":[{ | |
| "name" : "device_id", | |
| "in" : "path", | |
| "description" : "device id", | |
| "required" : true, | |
| "type" : "string" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/apiResults" | |
| } | |
| } | |
| }, | |
| "deprecated": false | |
| } | |
| }, | |
| "/qdb/dropon.do": { | |
| "get": { | |
| "tags": [ | |
| "qdb" | |
| ], | |
| "summary":"用於QDB模組的空投功能", | |
| "description":"給QDB模組中的空投功能呼叫使用，用以控制投放裝置的開閉", | |
| "operationId": "", | |
| "consumes": [], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/results" | |
| } | |
| } | |
| }, | |
| "deprecated": false | |
| } | |
| } | |
| }, | |
| "definitions": { | |
| "apiResults": { | |
| "type": "object", | |
| "properties": { | |
| "result": { | |
| "type": "boolean" | |
| }, | |
| "msg": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "results": { | |
| "type": "object", | |
| "properties": { | |
| "result": { | |
| "type": "boolean" | |
| }, | |
| "msg": { | |
| "type": "string" | |
| }, | |
| "value": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } |
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": "v1", | |
| "title": "Edubots dedicated api", | |
| "description": "For the edubots robot, through the Internet to obtain user information, and user interaction" | |
| }, | |
| "tags": [ { | |
| "name" : "authenticate", | |
| "description" : "User Verification Api" | |
| },{ | |
| "name" : "product", | |
| "description" : "Internet Mall Api" | |
| } ], | |
| "host": "edubot.kong.srm.pw", | |
| "schemes": [ | |
| "https" | |
| ], | |
| "basePath": "/edubots", | |
| "paths": { | |
| "/api/authenticate.do": { | |
| "post": { | |
| "tags": [ | |
| "authenticate" | |
| ], | |
| "summary":"User account verification", | |
| "description":"Get Token values through user accounts", | |
| "operationId": "", | |
| "consumes": [], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters":[{ | |
| "name" : "json", | |
| "in" : "formData", | |
| "description" : "json formate data，sample:{\"email\":\"xyz@abc.com\", \"password\":\"123456\"}", | |
| "required" : true, | |
| "type" : "string" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/auth_results" | |
| } | |
| } | |
| }, | |
| "deprecated": false | |
| } | |
| }, | |
| "/api/productCategory.do": { | |
| "post": { | |
| "tags": [ | |
| "product" | |
| ], | |
| "summary":"List of all products", | |
| "description":"Get all merchandise categories in the mall", | |
| "operationId": "", | |
| "consumes": [], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters":[{ | |
| "name" : "json", | |
| "in" : "formData", | |
| "description" : "json formate data，sample:{\"token\":\"zxcrtyg67hhhghyu789kkjygfg\"}", | |
| "required" : true, | |
| "type" : "string" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/product_results" | |
| } | |
| } | |
| }, | |
| "deprecated": false | |
| } | |
| }, | |
| "/api/lightcontrol.do": { | |
| "get": { | |
| "tags": [ | |
| "light control" | |
| ], | |
| "summary":"light controling(ON/OFF)", | |
| "description":"Control the light through the network", | |
| "operationId": "", | |
| "consumes": [], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters":[{ | |
| "name" : "action", | |
| "in" : "query", | |
| "description" : "the value of light controling(ON/OFF)", | |
| "required" : true, | |
| "type" : "string" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/control_results" | |
| } | |
| } | |
| }, | |
| "deprecated": false | |
| } | |
| } | |
| }, | |
| "definitions": { | |
| "auth_results": { | |
| "type": "object", | |
| "properties": { | |
| "result": { | |
| "type": "boolean" | |
| }, | |
| "msg": { | |
| "type": "string" | |
| }, | |
| "token": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "product_results": { | |
| "type": "object", | |
| "properties": { | |
| "result": { | |
| "type": "boolean" | |
| }, | |
| "msg": { | |
| "type": "string" | |
| }, | |
| "getProductsCategoryList": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "control_results": { | |
| "type": "object", | |
| "properties": { | |
| "result": { | |
| "type": "boolean" | |
| }, | |
| "msg": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } |
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": "v1", | |
| "title": "Edubots機器人專用api", | |
| "description": "用於edubots機器人，透過連網方式取得使用者資訊，與使用者互動" | |
| }, | |
| "tags": [ { | |
| "name" : "authenticate", | |
| "description" : "使用者驗證專用api" | |
| },{ | |
| "name" : "product", | |
| "description" : "網路商城專用api" | |
| } ], | |
| "host": "edubot.kong.srm.pw", | |
| "schemes": [ | |
| "https" | |
| ], | |
| "basePath": "/edubots", | |
| "paths": { | |
| "/api/authenticate.do": { | |
| "post": { | |
| "tags": [ | |
| "authenticate" | |
| ], | |
| "summary":"使用者帳密驗證", | |
| "description":"透過使用者帳密取得 Token 值", | |
| "operationId": "", | |
| "consumes": [], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters":[{ | |
| "name" : "json", | |
| "in" : "formData", | |
| "description" : "json格式資料，sample:{\"email\":\"xyz@abc.com\", \"password\":\"123456\"}", | |
| "required" : true, | |
| "type" : "string" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/auth_results" | |
| } | |
| } | |
| }, | |
| "deprecated": false | |
| } | |
| }, | |
| "/api/productCategory.do": { | |
| "post": { | |
| "tags": [ | |
| "product" | |
| ], | |
| "summary":"商品分類列表", | |
| "description":"取得商城中所有商品分類", | |
| "operationId": "", | |
| "consumes": [], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters":[{ | |
| "name" : "json", | |
| "in" : "formData", | |
| "description" : "json格式資料，sample:{\"token\":\"zddgfgffgfghr2.ghgnghghghg\"}", | |
| "required" : true, | |
| "type" : "string" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/product_results" | |
| } | |
| } | |
| }, | |
| "deprecated": false | |
| } | |
| }, | |
| "/api/lightcontrol.do": { | |
| "get": { | |
| "tags": [ | |
| "light control" | |
| ], | |
| "summary":"夜燈控制(開/關)", | |
| "description":"透過聯網控制夜燈", | |
| "operationId": "", | |
| "consumes": [], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters":[{ | |
| "name" : "action", | |
| "in" : "query", | |
| "description" : "夜燈控制動作值(ON/OFF)", | |
| "required" : true, | |
| "type" : "string" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/control_results" | |
| } | |
| } | |
| }, | |
| "deprecated": false | |
| } | |
| } | |
| }, | |
| "definitions": { | |
| "auth_results": { | |
| "type": "object", | |
| "properties": { | |
| "result": { | |
| "type": "boolean" | |
| }, | |
| "msg": { | |
| "type": "string" | |
| }, | |
| "token": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "product_results": { | |
| "type": "object", | |
| "properties": { | |
| "result": { | |
| "type": "boolean" | |
| }, | |
| "msg": { | |
| "type": "string" | |
| }, | |
| "getProductsCategoryList": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "control_results": { | |
| "type": "object", | |
| "properties": { | |
| "result": { | |
| "type": "boolean" | |
| }, | |
| "msg": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } |
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": "v1", | |
| "title": "Edubots情緒rule專用api", | |
| "description": "用於edubots機器人，透過連網方式取得情緒規則與表情圖集等資料，與使用者互動" | |
| }, | |
| "tags": [ { | |
| "name" : "emotion rule", | |
| "description" : "情緒規則api" | |
| }], | |
| "host": "service.inmedia.com.tw", | |
| "schemes": [ | |
| "http" | |
| ], | |
| "basePath": "/task", | |
| "paths": { | |
| "/api/botdata.do": { | |
| "post": { | |
| "tags": [ | |
| "authenticate" | |
| ], | |
| "summary":"情緒規則與表情圖集", | |
| "description":"透過連網方式取得rule等資訊", | |
| "operationId": "", | |
| "consumes": [], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters":[{ | |
| "name" : "jdatas", | |
| "in" : "formData", | |
| "description" : "json格式資料，sample:{\"data_type\":\"OCTOBO\"}", | |
| "required" : true, | |
| "type" : "string" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/return_result" | |
| } | |
| } | |
| }, | |
| "deprecated": false | |
| } | |
| } | |
| }, | |
| "definitions": { | |
| "return_result": { | |
| "type": "object", | |
| "properties": { | |
| "result": { | |
| "type": "boolean" | |
| }, | |
| "msg": { | |
| "type": "string" | |
| }, | |
| "imgs": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/img" | |
| } | |
| }, | |
| "rules": { | |
| "type": "object", | |
| "properties": { | |
| "action": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/action" | |
| } | |
| }, | |
| "emotion": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/emotion" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "img": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "integer" | |
| }, | |
| "version": { | |
| "type": "string" | |
| }, | |
| "file_name": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "action": { | |
| "type": "object", | |
| "properties": { | |
| "action": { | |
| "type": "integer" | |
| }, | |
| "tag": { | |
| "type": "string" | |
| }, | |
| "trigger": { | |
| "type": "string" | |
| }, | |
| "trigger_rule": { | |
| "type": "integer" | |
| }, | |
| "value": { | |
| "type": "string" | |
| }, | |
| "desc": { | |
| "type": "string" | |
| }, | |
| "sensors": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "emotion": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type": "integer" | |
| }, | |
| "data_type": { | |
| "type": "string" | |
| }, | |
| "emotion_type": { | |
| "type": "string" | |
| }, | |
| "emotion_name": { | |
| "type": "string" | |
| }, | |
| "emotion_id": { | |
| "type": "integer" | |
| }, | |
| "priority": { | |
| "type": "integer" | |
| }, | |
| "trigger_time": { | |
| "type": "integer" | |
| }, | |
| "trigger_value": { | |
| "type": "string" | |
| }, | |
| "img_name": { | |
| "type": "string" | |
| }, | |
| "contents": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/content" | |
| } | |
| } | |
| } | |
| }, | |
| "content": { | |
| "type": "object", | |
| "properties": { | |
| "id": { | |
| "type":"integer" | |
| }, | |
| "tts": { | |
| "type": "string" | |
| }, | |
| "pitch":{ | |
| "type": "string" | |
| }, | |
| "speed": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } |
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": "v1", | |
| "title": "Edubots dedicated api", | |
| "description": "For the edubots robot, through the Internet to obtain user information, and user interaction" | |
| }, | |
| "tags": [ { | |
| "name" : "authenticate", | |
| "description" : "User Verification Api" | |
| },{ | |
| "name" : "product", | |
| "description" : "Internet Mall Api" | |
| } ], | |
| "host": "edubot.kong.srm.pw", | |
| "schemes": [ | |
| "https" | |
| ], | |
| "basePath": "/edubots", | |
| "paths": { | |
| "/api/authenticate.do": { | |
| "post": { | |
| "tags": [ | |
| "authenticate" | |
| ], | |
| "summary":"User account verification", | |
| "description":"Get Token values through user accounts", | |
| "operationId": "", | |
| "consumes": [], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters":[{ | |
| "name" : "json", | |
| "in" : "formData", | |
| "description" : "json formate data，sample:{\"email\":\"xyz@abc.com\", \"password\":\"123456\"}", | |
| "required" : true, | |
| "type" : "string" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/auth_results" | |
| } | |
| } | |
| }, | |
| "deprecated": false | |
| } | |
| }, | |
| "/api/productCategory.do": { | |
| "post": { | |
| "tags": [ | |
| "product" | |
| ], | |
| "summary":"List of all products", | |
| "description":"Get all merchandise categories in the mall", | |
| "operationId": "", | |
| "consumes": [], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters":[{ | |
| "name" : "json", | |
| "in" : "formData", | |
| "description" : "json formate data，sample:{\"token\":\"zxcrtyg67hhhghyu789kkjygfg\"}", | |
| "required" : true, | |
| "type" : "string" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/product_results" | |
| } | |
| } | |
| }, | |
| "deprecated": false | |
| } | |
| }, | |
| "/api/lightcontrol.do": { | |
| "get": { | |
| "tags": [ | |
| "light control" | |
| ], | |
| "summary":"light controling(ON/OFF)", | |
| "description":"Control the light through the network", | |
| "operationId": "", | |
| "consumes": [], | |
| "produces": [ | |
| "application/json" | |
| ], | |
| "parameters":[{ | |
| "name" : "action", | |
| "in" : "query", | |
| "description" : "the value of light controling(ON/OFF)", | |
| "required" : true, | |
| "type" : "string" | |
| }], | |
| "responses": { | |
| "200": { | |
| "description": "successful operation", | |
| "schema": { | |
| "$ref": "#/definitions/control_results" | |
| } | |
| } | |
| }, | |
| "deprecated": false | |
| } | |
| } | |
| }, | |
| "definitions": { | |
| "auth_results": { | |
| "type": "object", | |
| "properties": { | |
| "result": { | |
| "type": "boolean" | |
| }, | |
| "msg": { | |
| "type": "string" | |
| }, | |
| "token": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "product_results": { | |
| "type": "object", | |
| "properties": { | |
| "result": { | |
| "type": "boolean" | |
| }, | |
| "msg": { | |
| "type": "string" | |
| }, | |
| "getProductsCategoryList": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "control_results": { | |
| "type": "object", | |
| "properties": { | |
| "result": { | |
| "type": "boolean" | |
| }, | |
| "msg": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| } | |
| } |
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: 1.0.0 | |
| title: III edubot chatting API | |
| description: > | |
| A edubot chatting API from III. | |
| host: chatbot.kong.srm.pw | |
| basePath: /chatbot | |
| tags: | |
| - name: "chatting" | |
| description: "III edubot chatting API" | |
| schemes: | |
| - "https" | |
| consumes: | |
| - application/json | |
| produces: | |
| - application/json | |
| paths: | |
| '/': | |
| get: | |
| tags: | |
| - chatting | |
| description: Returns a sentence for dialogue. | |
| parameters: | |
| - name: Text | |
| in: query | |
| description: Sentence of chatting. | |
| required: true | |
| type: string | |
| responses: | |
| '200': | |
| description: chatting response | |
| default: | |
| description: unexpected error |
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: | |
| description: "MetroWalk Management API" | |
| version: "1.0.0" | |
| title: "MetroWalk" | |
| contact: {} | |
| paths: | |
| /activity: | |
| get: | |
| summary: "List all Activity" | |
| description: "取得所有 Activity" | |
| produces: | |
| - "application/json" | |
| parameters: | |
| - name: "type" | |
| in: "query" | |
| description: "取得特定類型的活動" | |
| required: false | |
| type: "string" | |
| x-example: "訊息公告" | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| schema: | |
| type: "array" | |
| items: | |
| $ref: "#/definitions/Activity" | |
| post: | |
| summary: "Create Activity" | |
| description: "新建活動訊息 Activity" | |
| consumes: | |
| - "application/json" | |
| produces: | |
| - "application/json" | |
| parameters: | |
| - in: "body" | |
| name: "body" | |
| required: false | |
| schema: | |
| $ref: "#/definitions/Activity" | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| schema: | |
| $ref: "#/definitions/Activity" | |
| /activity/{id}: | |
| get: | |
| summary: "Get Activity" | |
| produces: | |
| - "application/json" | |
| parameters: | |
| - name: "id" | |
| in: "path" | |
| description: "Activity ID" | |
| required: true | |
| type: "string" | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| schema: | |
| $ref: "#/definitions/Activity" | |
| 404: | |
| description: "Status 404" | |
| put: | |
| summary: "Update Activity" | |
| consumes: | |
| - "application/json" | |
| produces: | |
| - "application/json" | |
| parameters: | |
| - name: "id" | |
| in: "path" | |
| description: "Activity ID" | |
| required: true | |
| type: "string" | |
| - in: "body" | |
| name: "body" | |
| required: false | |
| schema: | |
| $ref: "#/definitions/Activity" | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| schema: | |
| $ref: "#/definitions/Activity" | |
| 404: | |
| description: "Status 404" | |
| delete: | |
| summary: "Delete Activity" | |
| parameters: | |
| - name: "id" | |
| in: "path" | |
| description: "Activity ID" | |
| required: true | |
| type: "string" | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| 404: | |
| description: "Status 404" | |
| /ad: | |
| get: | |
| summary: "List all ADs" | |
| description: "取得所有廣告" | |
| produces: | |
| - "application/json" | |
| parameters: [] | |
| responses: | |
| 200: | |
| description: "廣告清單" | |
| schema: | |
| type: "array" | |
| items: | |
| $ref: "#/definitions/AD" | |
| post: | |
| summary: "Create AD" | |
| produces: | |
| - "application/json" | |
| parameters: [] | |
| responses: | |
| 200: | |
| description: "建立廣告" | |
| schema: | |
| $ref: "#/definitions/AD" | |
| /ad/{id}: | |
| get: | |
| summary: "Get AD" | |
| produces: | |
| - "application/json" | |
| parameters: | |
| - name: "id" | |
| in: "path" | |
| description: "廣告 id" | |
| required: true | |
| type: "integer" | |
| format: "int32" | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| schema: | |
| $ref: "#/definitions/AD" | |
| 404: | |
| description: "Status 404" | |
| put: | |
| summary: "Update AD" | |
| description: "更新廣告內容（包含上架、下架）" | |
| consumes: | |
| - "application/json" | |
| produces: | |
| - "application/json" | |
| parameters: | |
| - name: "id" | |
| in: "path" | |
| description: "廣告 id" | |
| required: true | |
| type: "integer" | |
| format: "int32" | |
| - in: "body" | |
| name: "body" | |
| required: false | |
| schema: | |
| $ref: "#/definitions/AD" | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| schema: | |
| $ref: "#/definitions/AD" | |
| delete: | |
| summary: "Delete AD" | |
| description: "刪除廣告" | |
| parameters: | |
| - name: "id" | |
| in: "path" | |
| description: "廣告 id" | |
| required: true | |
| type: "integer" | |
| format: "int32" | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| 404: | |
| description: "Status 404" | |
| /banner: | |
| get: | |
| summary: "List all Banners" | |
| description: "取得所有 Banner" | |
| produces: | |
| - "application/json" | |
| parameters: [] | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| schema: | |
| type: "array" | |
| items: | |
| $ref: "#/definitions/Banner" | |
| post: | |
| summary: "Create Banner" | |
| description: "新建廣告 Banner" | |
| consumes: | |
| - "application/json" | |
| produces: | |
| - "application/json" | |
| parameters: | |
| - in: "body" | |
| name: "body" | |
| required: false | |
| schema: | |
| $ref: "#/definitions/Banner" | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| schema: | |
| $ref: "#/definitions/Banner" | |
| /banner/{id}: | |
| get: | |
| summary: "Get Banner" | |
| produces: | |
| - "application/json" | |
| parameters: | |
| - name: "id" | |
| in: "path" | |
| description: "Banner's ID" | |
| required: true | |
| type: "string" | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| schema: | |
| $ref: "#/definitions/Banner" | |
| 404: | |
| description: "Status 404" | |
| put: | |
| summary: "Update Banner" | |
| consumes: | |
| - "application/json" | |
| produces: | |
| - "application/json" | |
| parameters: | |
| - name: "id" | |
| in: "path" | |
| description: "Banner's ID" | |
| required: true | |
| type: "string" | |
| - in: "body" | |
| name: "body" | |
| required: false | |
| schema: | |
| $ref: "#/definitions/Banner" | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| schema: | |
| $ref: "#/definitions/Banner" | |
| 404: | |
| description: "Status 404" | |
| delete: | |
| summary: "Delete Banner" | |
| parameters: | |
| - name: "id" | |
| in: "path" | |
| description: "Banner's ID" | |
| required: true | |
| type: "string" | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| 404: | |
| description: "Status 404" | |
| /broadcast-message: | |
| get: | |
| summary: "List all Broadcast Messages" | |
| description: "取得所有 Broadcast Messages" | |
| produces: | |
| - "application/json" | |
| parameters: [] | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| schema: | |
| type: "array" | |
| items: | |
| $ref: "#/definitions/BroadcastMessage" | |
| post: | |
| summary: "Create Broadcast Messages" | |
| description: "新建訊息 Broadcast Messages" | |
| consumes: | |
| - "application/json" | |
| produces: | |
| - "application/json" | |
| parameters: | |
| - in: "body" | |
| name: "body" | |
| required: false | |
| schema: | |
| $ref: "#/definitions/BroadcastMessage" | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| schema: | |
| $ref: "#/definitions/BroadcastMessage" | |
| /broadcast-message/{id}: | |
| get: | |
| summary: "Get Broadcast Messages" | |
| produces: | |
| - "application/json" | |
| parameters: | |
| - name: "id" | |
| in: "path" | |
| description: "Broadcast Messages ID" | |
| required: true | |
| type: "string" | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| schema: | |
| $ref: "#/definitions/BroadcastMessage" | |
| 404: | |
| description: "Status 404" | |
| put: | |
| summary: "Update Broadcast Messages" | |
| consumes: | |
| - "application/json" | |
| produces: | |
| - "application/json" | |
| parameters: | |
| - name: "id" | |
| in: "path" | |
| description: "Broadcast Messages ID" | |
| required: true | |
| type: "string" | |
| - in: "body" | |
| name: "body" | |
| required: false | |
| schema: | |
| $ref: "#/definitions/BroadcastMessage" | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| schema: | |
| $ref: "#/definitions/BroadcastMessage" | |
| 404: | |
| description: "Status 404" | |
| delete: | |
| summary: "Delete Broadcast Messages" | |
| parameters: | |
| - name: "id" | |
| in: "path" | |
| description: "Broadcast Messages ID" | |
| required: true | |
| type: "string" | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| 404: | |
| description: "Status 404" | |
| /card-image: | |
| get: | |
| summary: "List all Card Images" | |
| description: "取得所有 Card Images" | |
| produces: | |
| - "application/json" | |
| parameters: [] | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| schema: | |
| type: "array" | |
| items: | |
| $ref: "#/definitions/CardImage" | |
| post: | |
| summary: "Create Card Images" | |
| description: "新建廣告 Card Images" | |
| consumes: | |
| - "application/json" | |
| produces: | |
| - "application/json" | |
| parameters: | |
| - in: "body" | |
| name: "body" | |
| required: false | |
| schema: | |
| $ref: "#/definitions/CardImage" | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| schema: | |
| $ref: "#/definitions/CardImage" | |
| /card-image/{id}: | |
| get: | |
| summary: "Get Card Images" | |
| produces: | |
| - "application/json" | |
| parameters: | |
| - name: "id" | |
| in: "path" | |
| description: "Card Image ID" | |
| required: true | |
| type: "string" | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| schema: | |
| $ref: "#/definitions/CardImage" | |
| 404: | |
| description: "Status 404" | |
| put: | |
| summary: "Update Card Images" | |
| consumes: | |
| - "application/json" | |
| produces: | |
| - "application/json" | |
| parameters: | |
| - name: "id" | |
| in: "path" | |
| description: "Card Image ID" | |
| required: true | |
| type: "string" | |
| - in: "body" | |
| name: "body" | |
| required: false | |
| schema: | |
| $ref: "#/definitions/CardImage" | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| schema: | |
| $ref: "#/definitions/CardImage" | |
| 404: | |
| description: "Status 404" | |
| delete: | |
| summary: "Delete Card Images" | |
| parameters: | |
| - name: "id" | |
| in: "path" | |
| description: "Card Image ID" | |
| required: true | |
| type: "string" | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| 404: | |
| description: "Status 404" | |
| /login: | |
| post: | |
| summary: "Login" | |
| consumes: | |
| - "application/json" | |
| produces: | |
| - "application/json" | |
| parameters: | |
| - name: "x-metrowalk-api-token" | |
| in: "header" | |
| required: false | |
| type: "string" | |
| - in: "body" | |
| name: "body" | |
| required: false | |
| schema: | |
| $ref: "#/definitions/UserLogin" | |
| responses: | |
| 200: | |
| description: "登入成功" | |
| schema: | |
| $ref: "#/definitions/Token" | |
| 401: | |
| description: "登入失敗" | |
| /meal: | |
| get: | |
| summary: "List all Recommend Meal" | |
| description: "取得所有 Recommend Meal" | |
| produces: | |
| - "application/json" | |
| parameters: | |
| - name: "recommend" | |
| in: "query" | |
| description: "只顯示有被推薦的餐點" | |
| required: false | |
| type: "boolean" | |
| x-example: true | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| schema: | |
| type: "array" | |
| items: | |
| $ref: "#/definitions/Meal" | |
| post: | |
| summary: "Create Recommend Meal" | |
| description: "新建餐廳 Recommend Meal" | |
| consumes: | |
| - "application/json" | |
| produces: | |
| - "application/json" | |
| parameters: | |
| - in: "body" | |
| name: "body" | |
| required: false | |
| schema: | |
| $ref: "#/definitions/Meal" | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| schema: | |
| $ref: "#/definitions/Meal" | |
| /meal/{id}: | |
| get: | |
| summary: "Get Recommend Meal" | |
| produces: | |
| - "application/json" | |
| parameters: | |
| - name: "id" | |
| in: "path" | |
| description: "Recommend Meal ID" | |
| required: true | |
| type: "string" | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| schema: | |
| $ref: "#/definitions/Meal" | |
| 404: | |
| description: "Status 404" | |
| put: | |
| summary: "Update Recommend Meal" | |
| consumes: | |
| - "application/json" | |
| produces: | |
| - "application/json" | |
| parameters: | |
| - name: "id" | |
| in: "path" | |
| description: "Recommend Meal ID" | |
| required: true | |
| type: "string" | |
| - in: "body" | |
| name: "body" | |
| required: false | |
| schema: | |
| $ref: "#/definitions/Meal" | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| schema: | |
| $ref: "#/definitions/Meal" | |
| 404: | |
| description: "Status 404" | |
| delete: | |
| summary: "Delete Recommend Meal" | |
| parameters: | |
| - name: "id" | |
| in: "path" | |
| description: "Recommend Meal ID" | |
| required: true | |
| type: "string" | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| 404: | |
| description: "Status 404" | |
| /movie-entrance: | |
| get: | |
| summary: "Get all Movie Entrance Images" | |
| parameters: [] | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| post: | |
| summary: "Create Movie Entrance Image" | |
| consumes: | |
| - "application/json" | |
| produces: | |
| - "application/json" | |
| parameters: | |
| - in: "body" | |
| name: "body" | |
| required: false | |
| schema: | |
| $ref: "#/definitions/MovieEntrance" | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| schema: | |
| $ref: "#/definitions/MovieEntrance" | |
| /movie-entrance/{id}: | |
| get: | |
| summary: "Get Movie Entrance Image" | |
| produces: | |
| - "application/json" | |
| parameters: | |
| - name: "id" | |
| in: "path" | |
| required: true | |
| type: "string" | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| schema: | |
| $ref: "#/definitions/MovieEntrance" | |
| 404: | |
| description: "Status 404" | |
| put: | |
| summary: "Update Movie Entrance Image" | |
| consumes: | |
| - "application/json" | |
| parameters: | |
| - name: "id" | |
| in: "path" | |
| required: true | |
| type: "string" | |
| - in: "body" | |
| name: "body" | |
| required: false | |
| schema: | |
| $ref: "#/definitions/MovieEntrance" | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| 404: | |
| description: "Status 404" | |
| delete: | |
| summary: "Delete Movie Entrance Image" | |
| parameters: | |
| - name: "id" | |
| in: "path" | |
| required: true | |
| type: "string" | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| 404: | |
| description: "Status 404" | |
| /recommend-product: | |
| get: | |
| summary: "List all Recommend Product" | |
| description: "取得所有 Recommend Product" | |
| produces: | |
| - "application/json" | |
| parameters: [] | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| schema: | |
| type: "array" | |
| items: | |
| $ref: "#/definitions/RecommendProduct" | |
| post: | |
| summary: "Create Recommend Product" | |
| description: "新建餐廳 Recommend Product" | |
| consumes: | |
| - "application/json" | |
| produces: | |
| - "application/json" | |
| parameters: | |
| - in: "body" | |
| name: "body" | |
| required: false | |
| schema: | |
| $ref: "#/definitions/RecommendProduct" | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| schema: | |
| $ref: "#/definitions/RecommendProduct" | |
| /recommend-product/{id}: | |
| get: | |
| summary: "Get Recommend Product" | |
| produces: | |
| - "application/json" | |
| parameters: | |
| - name: "id" | |
| in: "path" | |
| description: "Recommend Product ID" | |
| required: true | |
| type: "string" | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| schema: | |
| $ref: "#/definitions/RecommendProduct" | |
| 404: | |
| description: "Status 404" | |
| put: | |
| summary: "Update Recommend Product" | |
| consumes: | |
| - "application/json" | |
| produces: | |
| - "application/json" | |
| parameters: | |
| - name: "id" | |
| in: "path" | |
| description: "Recommend Product ID" | |
| required: true | |
| type: "string" | |
| - in: "body" | |
| name: "body" | |
| required: false | |
| schema: | |
| $ref: "#/definitions/RecommendProduct" | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| schema: | |
| $ref: "#/definitions/RecommendProduct" | |
| 404: | |
| description: "Status 404" | |
| delete: | |
| summary: "Delete Recommend Product" | |
| parameters: | |
| - name: "id" | |
| in: "path" | |
| description: "Recommend Product ID" | |
| required: true | |
| type: "string" | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| 404: | |
| description: "Status 404" | |
| /restaurant: | |
| get: | |
| summary: "List all Restaurants" | |
| description: "取得所有 Restaurants" | |
| produces: | |
| - "application/json" | |
| parameters: | |
| - name: "recommend" | |
| in: "query" | |
| description: "只顯示有被推薦的餐廳" | |
| required: false | |
| type: "boolean" | |
| x-example: true | |
| - name: "category" | |
| in: "query" | |
| description: "取得特定類型餐廳" | |
| required: false | |
| type: "string" | |
| x-example: "中菜" | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| schema: | |
| type: "array" | |
| items: | |
| $ref: "#/definitions/Restaurant" | |
| post: | |
| summary: "Create Restaurant" | |
| description: "新建餐廳 Restaurant" | |
| consumes: | |
| - "application/json" | |
| produces: | |
| - "application/json" | |
| parameters: | |
| - in: "body" | |
| name: "body" | |
| required: false | |
| schema: | |
| $ref: "#/definitions/Restaurant" | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| schema: | |
| $ref: "#/definitions/Restaurant" | |
| /restaurant-category: | |
| get: | |
| summary: "List all Restaurant Category" | |
| description: "取得所有 Restaurant Category 權重資料" | |
| produces: | |
| - "application/json" | |
| parameters: [] | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| schema: | |
| type: "array" | |
| items: | |
| $ref: "#/definitions/RestaurantCategory" | |
| post: | |
| summary: "Create Restaurant Category" | |
| description: "新建餐廳類別權重" | |
| consumes: | |
| - "application/json" | |
| produces: | |
| - "application/json" | |
| parameters: | |
| - in: "body" | |
| name: "body" | |
| required: false | |
| schema: | |
| $ref: "#/definitions/RestaurantCategory" | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| schema: | |
| $ref: "#/definitions/RestaurantCategory" | |
| /restaurant-category/{id}: | |
| get: | |
| summary: "Get Restaurant Category" | |
| produces: | |
| - "application/json" | |
| parameters: | |
| - name: "id" | |
| in: "path" | |
| description: "Restaurant Category ID" | |
| required: true | |
| type: "string" | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| schema: | |
| $ref: "#/definitions/RestaurantCategory" | |
| 404: | |
| description: "Status 404" | |
| put: | |
| summary: "Update Restaurant Category" | |
| consumes: | |
| - "application/json" | |
| produces: | |
| - "application/json" | |
| parameters: | |
| - name: "id" | |
| in: "path" | |
| description: "Restaurant Category ID" | |
| required: true | |
| type: "string" | |
| - in: "body" | |
| name: "body" | |
| required: false | |
| schema: | |
| $ref: "#/definitions/RestaurantCategory" | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| schema: | |
| $ref: "#/definitions/RestaurantCategory" | |
| 404: | |
| description: "Status 404" | |
| delete: | |
| summary: "Delete Restaurant Category" | |
| parameters: | |
| - name: "id" | |
| in: "path" | |
| description: "Restaurant Category ID" | |
| required: true | |
| type: "string" | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| 404: | |
| description: "Status 404" | |
| /restaurant-recommend-category: | |
| get: | |
| summary: "Get all restaurant categories" | |
| description: "取得所有餐廳類別, 依照 /restaurant-category 內的 priority 排序, 數值越大越前面, 預設值\ | |
| 為 0" | |
| parameters: [] | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| schema: | |
| type: "array" | |
| items: | |
| type: "string" | |
| /restaurant-service: | |
| get: | |
| summary: "List all Restaurant Service" | |
| description: "取得所有 Restaurant Service 權重資料" | |
| produces: | |
| - "application/json" | |
| parameters: [] | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| schema: | |
| type: "array" | |
| items: | |
| $ref: "#/definitions/RestaurantService" | |
| post: | |
| summary: "Create Service" | |
| description: "新建餐廳服務" | |
| consumes: | |
| - "application/json" | |
| produces: | |
| - "application/json" | |
| parameters: | |
| - in: "body" | |
| name: "body" | |
| required: false | |
| schema: | |
| $ref: "#/definitions/RestaurantService" | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| schema: | |
| $ref: "#/definitions/RestaurantService" | |
| /restaurant-service/{id}: | |
| get: | |
| summary: "Get Restaurant Service" | |
| produces: | |
| - "application/json" | |
| parameters: | |
| - name: "id" | |
| in: "path" | |
| description: "Restaurant Service ID" | |
| required: true | |
| type: "string" | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| schema: | |
| $ref: "#/definitions/RestaurantService" | |
| 404: | |
| description: "Status 404" | |
| put: | |
| summary: "Update Restaurant Service" | |
| consumes: | |
| - "application/json" | |
| produces: | |
| - "application/json" | |
| parameters: | |
| - name: "id" | |
| in: "path" | |
| description: "Restaurant Service ID" | |
| required: true | |
| type: "string" | |
| - in: "body" | |
| name: "body" | |
| required: false | |
| schema: | |
| $ref: "#/definitions/RestaurantService" | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| schema: | |
| $ref: "#/definitions/RestaurantService" | |
| 404: | |
| description: "Status 404" | |
| delete: | |
| summary: "Delete Restaurant Service" | |
| parameters: | |
| - name: "id" | |
| in: "path" | |
| description: "Restaurant Service ID" | |
| required: true | |
| type: "string" | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| 404: | |
| description: "Status 404" | |
| /restaurant/{id}: | |
| get: | |
| summary: "Get Restaurant" | |
| produces: | |
| - "application/json" | |
| parameters: | |
| - name: "id" | |
| in: "path" | |
| description: "Restaurant ID" | |
| required: true | |
| type: "string" | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| schema: | |
| $ref: "#/definitions/Restaurant" | |
| 404: | |
| description: "Status 404" | |
| put: | |
| summary: "Update Restaurant" | |
| consumes: | |
| - "application/json" | |
| produces: | |
| - "application/json" | |
| parameters: | |
| - name: "id" | |
| in: "path" | |
| description: "Restaurant ID" | |
| required: true | |
| type: "string" | |
| - in: "body" | |
| name: "body" | |
| required: false | |
| schema: | |
| $ref: "#/definitions/Restaurant" | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| schema: | |
| $ref: "#/definitions/Restaurant" | |
| 404: | |
| description: "Status 404" | |
| delete: | |
| summary: "Delete Restaurant" | |
| parameters: | |
| - name: "id" | |
| in: "path" | |
| description: "Restaurant ID" | |
| required: true | |
| type: "string" | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| 404: | |
| description: "Status 404" | |
| /uploads: | |
| post: | |
| produces: | |
| - "application/json" | |
| parameters: [] | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| schema: | |
| $ref: "#/definitions/Download" | |
| /user: | |
| post: | |
| summary: "Create User" | |
| description: "新建使用者" | |
| consumes: | |
| - "application/json" | |
| produces: | |
| - "application/json" | |
| parameters: | |
| - in: "body" | |
| name: "body" | |
| required: false | |
| schema: | |
| $ref: "#/definitions/User" | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| schema: | |
| $ref: "#/definitions/User" | |
| /user/{id}: | |
| get: | |
| summary: "Get User" | |
| description: "取得使用者" | |
| produces: | |
| - "application/json" | |
| parameters: | |
| - name: "id" | |
| in: "path" | |
| description: "使用者 id" | |
| required: true | |
| type: "integer" | |
| format: "int32" | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| schema: | |
| $ref: "#/definitions/User" | |
| put: | |
| summary: "Update User" | |
| description: "更新使用者資料 (含權限)" | |
| consumes: | |
| - "application/json" | |
| parameters: | |
| - name: "id" | |
| in: "path" | |
| description: "使用者 id" | |
| required: true | |
| type: "integer" | |
| format: "int32" | |
| - in: "body" | |
| name: "body" | |
| required: false | |
| schema: | |
| $ref: "#/definitions/User" | |
| responses: | |
| 200: | |
| description: "Status 200" | |
| 404: | |
| description: "Status 404" | |
| delete: | |
| summary: "Delete User" | |
| description: "刪除使用者" | |
| parameters: | |
| - name: "id" | |
| in: "path" | |
| description: "使用者 id" | |
| required: true | |
| type: "integer" | |
| format: "int32" | |
| responses: | |
| 200: | |
| description: "成功刪除" | |
| 404: | |
| description: "找不到此使用者" | |
| definitions: | |
| User: | |
| type: "object" | |
| required: | |
| - "password" | |
| - "permission" | |
| - "role" | |
| - "username" | |
| properties: | |
| username: | |
| type: "string" | |
| description: "Username of user" | |
| password: | |
| type: "string" | |
| description: "(encrypted) Password of user" | |
| role: | |
| type: "string" | |
| description: "Role of user" | |
| permission: | |
| type: "array" | |
| description: "管理權限: 1~9" | |
| items: | |
| type: "string" | |
| UserLogin: | |
| type: "object" | |
| required: | |
| - "password" | |
| - "username" | |
| properties: | |
| username: | |
| type: "string" | |
| description: "帳號" | |
| password: | |
| type: "string" | |
| description: "密碼" | |
| Token: | |
| type: "object" | |
| required: | |
| - "x-metrowalk-api-token" | |
| properties: | |
| x-metrowalk-api-token: | |
| type: "string" | |
| description: "登入權杖, 每次 header 中皆須帶入" | |
| Download: | |
| type: "object" | |
| required: | |
| - "url" | |
| properties: | |
| url: | |
| type: "string" | |
| description: "下載網址" | |
| AD: | |
| type: "object" | |
| required: | |
| - "content" | |
| - "enable" | |
| - "mode" | |
| - "name" | |
| properties: | |
| enable: | |
| type: "boolean" | |
| description: "開啟/關閉 此廣告" | |
| default: false | |
| name: | |
| type: "string" | |
| description: "廣告名稱" | |
| content: | |
| type: "string" | |
| description: "圖片連結或純文字" | |
| mode: | |
| type: "string" | |
| description: "模式選擇：\"圖片\" or \"純文字\"" | |
| activeTime: | |
| type: "string" | |
| format: "date" | |
| description: "從什麼時候開始上架 (iso 8601)" | |
| inactiveTime: | |
| type: "string" | |
| format: "date" | |
| description: "從什麼時候下架 (iso 8601)" | |
| description: "廣告視窗管理" | |
| Banner: | |
| type: "object" | |
| required: | |
| - "enable" | |
| - "link" | |
| properties: | |
| enable: | |
| type: "boolean" | |
| description: "啟動/關閉 本輪播廣告" | |
| default: false | |
| appUrl: | |
| type: "string" | |
| description: "對應 APP 開啟內頁 (deeplink)" | |
| link: | |
| type: "string" | |
| description: "廣告連結頁面" | |
| priority: | |
| type: "integer" | |
| format: "int32" | |
| description: "排序" | |
| activeTime: | |
| type: "string" | |
| format: "date" | |
| description: "上架時間" | |
| inactiveTime: | |
| type: "string" | |
| format: "date" | |
| description: "下架時間" | |
| description: "首頁輪播 Banner 管理" | |
| MovieEntrance: | |
| type: "object" | |
| required: | |
| - "image" | |
| - "link" | |
| properties: | |
| image: | |
| type: "string" | |
| description: "廣告圖片連結" | |
| link: | |
| type: "string" | |
| description: "廣告連結" | |
| description: "電影資訊入口圖" | |
| CardImage: | |
| type: "object" | |
| required: | |
| - "image" | |
| - "name" | |
| properties: | |
| name: | |
| type: "string" | |
| description: "卡片名稱" | |
| image: | |
| type: "string" | |
| description: "卡片圖片位置" | |
| description: "卡片圖" | |
| BroadcastMessage: | |
| type: "object" | |
| required: | |
| - "title" | |
| properties: | |
| title: | |
| type: "string" | |
| description: "推播標題" | |
| text: | |
| type: "string" | |
| description: "推播內容" | |
| pushType: | |
| type: "string" | |
| description: "推播類別：一般訊息、特殊訊息、點數到期" | |
| pushTarget: | |
| type: "string" | |
| description: "推播對象會員編號 111,222,333,444 若空 則全部" | |
| pushTime: | |
| type: "string" | |
| format: "date" | |
| description: "推播時間" | |
| description: "會員訊息管理" | |
| RecommendProduct: | |
| type: "object" | |
| required: | |
| - "description" | |
| - "image" | |
| - "location" | |
| - "name" | |
| - "price" | |
| - "priceText" | |
| - "shareText" | |
| properties: | |
| image: | |
| type: "string" | |
| description: "推薦圖片位置" | |
| name: | |
| type: "string" | |
| description: "名稱" | |
| location: | |
| type: "string" | |
| description: "品牌/樓層" | |
| priceText: | |
| type: "string" | |
| description: "價格名稱" | |
| price: | |
| type: "integer" | |
| format: "int32" | |
| description: "價格" | |
| description: | |
| type: "string" | |
| description: "簡介" | |
| note: | |
| type: "string" | |
| description: "備註" | |
| shareText: | |
| type: "string" | |
| description: "分享內容" | |
| activeTime: | |
| type: "string" | |
| format: "date" | |
| description: "檔期開始時間" | |
| inactiveTime: | |
| type: "string" | |
| format: "date" | |
| description: "檔期結束時間" | |
| description: "推薦商品" | |
| Restaurant: | |
| type: "object" | |
| required: | |
| - "category" | |
| - "chapiCard" | |
| - "description" | |
| - "images" | |
| - "location" | |
| - "logo" | |
| - "metrowalkCard" | |
| - "name" | |
| - "phone" | |
| - "services" | |
| properties: | |
| name: | |
| type: "string" | |
| description: "餐廳名稱" | |
| logo: | |
| type: "string" | |
| description: "LOGO 圖片位置" | |
| phone: | |
| type: "string" | |
| description: "餐廳電話" | |
| images: | |
| type: "array" | |
| description: "圖片列表" | |
| items: | |
| type: "string" | |
| location: | |
| type: "string" | |
| description: "餐廳位置" | |
| category: | |
| type: "string" | |
| description: "分類名稱" | |
| description: | |
| type: "string" | |
| description: "餐廳簡介" | |
| services: | |
| type: "array" | |
| description: "餐廳服務項目：服務費、國民旅遊卡、禁帶寵物、嬰兒座椅、現場候位、可訂位、包廂\n(現場候位、可訂位為互斥選項)" | |
| items: | |
| type: "string" | |
| metrowalkCard: | |
| type: "string" | |
| description: "大江聯名卡優惠說明" | |
| chapiCard: | |
| type: "string" | |
| description: "ChaPi 卡優惠說明" | |
| Meals: | |
| type: "array" | |
| description: "餐點資料 (read only) 更改需由 /meal/:id" | |
| items: | |
| $ref: "#/definitions/Meal" | |
| description: "餐廳資訊" | |
| RestaurantCategory: | |
| type: "object" | |
| required: | |
| - "category" | |
| - "priority" | |
| properties: | |
| category: | |
| type: "string" | |
| description: "類別名 (唯一)" | |
| priority: | |
| type: "integer" | |
| format: "int32" | |
| description: "權重 (越大越前面)" | |
| description: "餐廳類別優先權表" | |
| RestaurantService: | |
| type: "object" | |
| required: | |
| - "service" | |
| properties: | |
| service: | |
| type: "string" | |
| description: "服務名 (唯一)" | |
| description: "餐廳服務" | |
| Meal: | |
| type: "object" | |
| required: | |
| - "description" | |
| - "images" | |
| - "info" | |
| - "name" | |
| - "price" | |
| - "priceText" | |
| - "recommend" | |
| - "resturant" | |
| - "shareText" | |
| properties: | |
| name: | |
| type: "string" | |
| description: "名稱" | |
| recommend: | |
| type: "boolean" | |
| default: false | |
| images: | |
| type: "array" | |
| description: "圖片列表" | |
| items: | |
| type: "string" | |
| info: | |
| type: "string" | |
| description: "說明" | |
| description: | |
| type: "string" | |
| description: "介紹" | |
| price: | |
| type: "integer" | |
| format: "int32" | |
| description: "價格" | |
| priceText: | |
| type: "string" | |
| description: "價格名稱" | |
| resturant: | |
| description: "供應餐廳資訊" | |
| $ref: "#/definitions/Restaurant" | |
| note: | |
| type: "string" | |
| description: "備註" | |
| shareText: | |
| type: "string" | |
| description: "分享內容" | |
| activeTime: | |
| type: "string" | |
| format: "date" | |
| description: "上架時間" | |
| inactiveTime: | |
| type: "string" | |
| format: "date" | |
| description: "下架時間" | |
| description: "餐點" | |
| Activity: | |
| type: "object" | |
| required: | |
| - "content" | |
| - "enable" | |
| - "image" | |
| - "location" | |
| - "name" | |
| - "shareText" | |
| - "title" | |
| - "type" | |
| properties: | |
| enable: | |
| type: "boolean" | |
| description: "啟用" | |
| default: false | |
| name: | |
| type: "string" | |
| description: "名稱" | |
| type: | |
| type: "string" | |
| description: "分類：全館活動、企劃活動、訊息公告" | |
| image: | |
| type: "string" | |
| description: "圖片" | |
| title: | |
| type: "string" | |
| description: "標題" | |
| location: | |
| type: "string" | |
| description: "品牌/樓層" | |
| content: | |
| type: "string" | |
| description: "內文" | |
| note: | |
| type: "string" | |
| description: "備註" | |
| shareText: | |
| type: "string" | |
| description: "分享內容" | |
| activeTime: | |
| type: "string" | |
| format: "date" | |
| description: "上架時間" | |
| inactiveTime: | |
| type: "string" | |
| format: "date" | |
| description: "下架時間" | |
| description: "活動訊息" |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment