From 35b653a9d1cebce3d46d46c440a0697df8ebbe2d Mon Sep 17 00:00:00 2001 From: 3y Date: Wed, 12 Jan 2022 22:56:46 +0800 Subject: [PATCH] swagger info --- .../java/com/java3y/austin/controller/SendController.java | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/austin-web/src/main/java/com/java3y/austin/controller/SendController.java b/austin-web/src/main/java/com/java3y/austin/controller/SendController.java index a4478a2..ca8c5bb 100644 --- a/austin-web/src/main/java/com/java3y/austin/controller/SendController.java +++ b/austin-web/src/main/java/com/java3y/austin/controller/SendController.java @@ -3,6 +3,7 @@ package com.java3y.austin.controller; import com.java3y.austin.domain.SendRequest; import com.java3y.austin.domain.SendResponse; import com.java3y.austin.service.SendService; +import io.swagger.annotations.*; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.web.bind.annotation.PostMapping; import org.springframework.web.bind.annotation.RequestBody; @@ -12,6 +13,7 @@ import org.springframework.web.bind.annotation.RestController; * @author 三歪 */ +@Api(tags={"发送消息"}) @RestController public class SendController { @@ -24,8 +26,10 @@ public class SendController { * 示例：curl -XPOST "127.0.0.1:8080/send" -H 'Content-Type: application/json' -d '{"code":"send","messageParam":{"receiver":"13788888888","variables":{"title":"yyyyyy","contentValue":"6666164180"}},"messageTemplateId":1}' * @return */ + @ApiOperation(value = "下发接口",notes = "多渠道多类型下发消息，目前支持邮件和短信，类型支持：验证码、通知类、营销类") @PostMapping("/send") - public SendResponse send(@RequestBody SendRequest sendRequest) { + public SendResponse send(@ApiParam(value = "下发消息参数",required = true, examples = @Example(@ExampleProperty(mediaType = "application/json", value = "{\"code\":\"send\",\"messageParam\":{\"receiver\":\"13788888888\",\"variables\":{\"title\":\"yyyyyy\",\"contentValue\":\"6666164180\"}},\"messageTemplateId\":1}")),example = "{\"code\":\"send\",\"messageParam\":{\"receiver\":\"13788888888\",\"variables\":{\"title\":\"yyyyyy\",\"contentValue\":\"6666164180\"}},\"messageTemplateId\":1}") + @RequestBody SendRequest sendRequest) { return sendService.send(sendRequest); } }