yunnan swagger doc

liuxiaolong

2019-08-22 68fc51cb635fecf12cad58deab88c3b5e0afc0ad

 controllers/task.go

@@ -34,6 +34,7 @@
   FaceExtract_VirtualSdkId = "virtual-faceextract-sdk-pull"//结果输出的算法id
)

/*
// @Summary 查找所有任务，包含任务信息和对应的算法信息
// @Description 查找所有任务
// @Produce json
@@ -41,6 +42,7 @@
// @Success 200 {string} json "{"code":200, msg:"请求处理成功",data:"",success:true}"
// @Failure 500 {string} json "{"code":500, msg:"请求失败",data:"",success:false}"
// @Router /data/api-v/task/findAll [GET]
*/
func (tc TaskController) FindAll(c *gin.Context) {
   // 显示所有任务: 获取信息
   var taskApi dbapi.TaskApi
@@ -65,6 +67,7 @@
   }
}

/*
// @Summary 添加任务
// @Description 查找所有任务
// @Accept json
@@ -74,6 +77,7 @@
// @Success 200 {string} json "{"code":200, msg:"请求处理成功",data:"",success:true}"
// @Failure 500 {string} json "{"code":500, msg:"请求失败",data:"",success:false}"
// @Router /data/api-v/task/addTask [POST]
*/
func (tc TaskController) AddTask(c *gin.Context) {
   var task TaskVo
   var taskApi dbapi.TaskApi
@@ -101,6 +105,7 @@
   Sort int `json:"sort"`
}

/*
// @Summary 给任务添加算法
// @Description 任务添加算法
// @Produce json
@@ -109,6 +114,7 @@
// @Success 200 {string} json "{"code":200, msg:"请求处理成功",data:"",success:true}"
// @Failure 500 {string} json "{"code":500, msg:"请求失败",data:"",success:false}"
// @Router /data/api-v/task/addTaskSdk [post]
*/
func (tc TaskController) AddTaskSdk(c *gin.Context) {
   var addVo TaskSdkAdd
   err := c.BindJSON(&addVo)
@@ -126,6 +132,7 @@
   }
}

/*
// @Summary 任务删除算法
// @Description 根据taskid和sdkid删除
// @Produce json
@@ -135,6 +142,7 @@
// @Success 200 {string} json "{"code":200, msg:"请求处理成功",data:"",success:true}"
// @Failure 500 {string} json "{"code":500, msg:"请求失败",data:"",success:false}"
// @Router /data/api-v/task/delTaskSdk [GET]
*/
func (tc TaskController) DeleteTaskSdk(c *gin.Context) {
   var taskApi dbapi.TaskApi
   taskId := c.Query("taskId")
@@ -151,6 +159,7 @@
   }
}

/*
// @Summary 更新任务名称
// @Description 更新任务名称
// @Produce json
@@ -160,6 +169,7 @@
// @Success 200 {string} json "{"code":200, msg:"",data:"",success:true}"
// @Failure 500 {string} json "{"code":500, msg:"",data:"",success:false}"
// @Router /data/api-v/task/updateTaskName [POST]
*/
func (tc TaskController) UpdateTaskName(c *gin.Context) {
   taskId := c.PostForm("taskId")
   taskName := c.PostForm("taskName")
@@ -181,6 +191,7 @@
   Enable bool `json:"enable"`
}

/*
// @Summary 更新任务状态
// @Description （算法不变,只更新任务状态）
// @Produce json
@@ -189,6 +200,7 @@
// @Success 200 {string} json "{"code":200, msg:"请求处理成功",data:"",success:true}"
// @Failure 500 {string} json "{"code":500, msg:"请求失败",data:"",success:false}"
// @Router /data/api-v/task/updateTaskStatus [POST]
*/
func (tc TaskController) UpdateTaskStatus(c *gin.Context) {
   var tsvo TaskStatusVo
   err := c.BindJSON(&tsvo)
@@ -207,6 +219,7 @@
}


/*
// @Summary 删除任务
// @Description 根据任务id删除任务
// @Produce json
@@ -215,6 +228,7 @@
// @Success 200 {string} json "{"code":200, msg:"请求处理成功",data:"",success:true}"
// @Failure 500 {string} json "{"code":500, msg:"请求失败",data:"",success:false}"
// @Router /data/api-v/task/delete [GET]
*/
func (tc TaskController) DeleteTask(c *gin.Context) {
   var taskApi dbapi.TaskApi
   taskId := c.Query("taskId")
@@ -244,6 +258,7 @@
   SdkArgValue string `json:"sdk_arg_value"`
}

/*
// @Summary 保存算法规则
// @Description 保存算法规则
// @Accept json
@@ -253,6 +268,7 @@
// @Success 200 {string} json "{"code":200, success:true, msg:"", data:""}"
// @Failure 500 {string} json "{"code":500, success:false, msg:"",data:""}"
// @Router /data/api-v/task/saveTaskSdkRule [post]
*/
func (tc TaskController) SaveTaskSdkRule(c *gin.Context) {
   var rules TaskSdkRules
   err := c.BindJSON(&rules)
@@ -270,6 +286,7 @@
   }
}

/*
// @Summary 删除算法规则
// @Description 删除算法规则
// @Produce json
@@ -278,6 +295,7 @@
// @Success 200 {string} json "{"code":200, success:true, msg:"", data:""}"
// @Failure 500 {string} json "{"code":500, success:false, msg:"",data:""}"
// @Router /data/api-v/task/deleteTaskSdkRule [post]
*/
func (tc TaskController) DeleteTaskSdkRule(c *gin.Context) {
   taskId := c.PostForm("taskId")
   sdkId := c.PostForm("sdkId")
@@ -294,6 +312,7 @@
}


/*
// @Summary 查询算法规则
// @Description 查询算法规则
// @Produce json
@@ -303,6 +322,7 @@
// @Success 200 {string} json "{"code":200, success:true, msg:"", data:""}"
// @Failure 500 {string} json "{"code":500, success:false, msg:"",data:""}"
// @Router /data/api-v/task/getRulesByTaskSdk [get]
*/
func (tc TaskController) GetRulesByTaskSdk(c *gin.Context) {
   taskId := c.Query("taskId")
   sdkId := c.Query("sdkId")