From 9867f6d5c5bccfe52b878c344c536905dd6b309e Mon Sep 17 00:00:00 2001
From: riku <risaku@163.com>
Date: 星期四, 09 六月 2022 08:48:06 +0800
Subject: [PATCH] 1. 接口文档自动输出
---
src/main/kotlin/cn/flightfeather/supervision/lightshare/web/LedgerController.kt | 53 ++++++++++++++++++++++++++++++-----------------------
1 files changed, 30 insertions(+), 23 deletions(-)
diff --git a/src/main/kotlin/cn/flightfeather/supervision/lightshare/web/LedgerController.kt b/src/main/kotlin/cn/flightfeather/supervision/lightshare/web/LedgerController.kt
index 42d1ee6..f26771b 100644
--- a/src/main/kotlin/cn/flightfeather/supervision/lightshare/web/LedgerController.kt
+++ b/src/main/kotlin/cn/flightfeather/supervision/lightshare/web/LedgerController.kt
@@ -9,6 +9,7 @@
import org.springframework.web.bind.annotation.*
import org.springframework.web.multipart.MultipartFile
import org.synchronoss.cloud.nio.multipart.Multipart
+import springfox.documentation.annotations.ApiIgnore
import javax.servlet.http.HttpServletResponse
@Api(tags = ["鍙拌处API鎺ュ彛"])
@@ -16,56 +17,62 @@
@RequestMapping("/ledger")
class LedgerController(val ledgerService: LedgerService) {
+ @ApiOperation(value = "鑾峰彇鍙拌处绫诲瀷")
@GetMapping("/type")
fun getLedgerType(
- @RequestParam(value = "sceneType") sceneType: Int
+ @ApiParam("鍦烘櫙绫诲瀷id") @RequestParam(value = "sceneType") sceneType: Int
) = ledgerService.getLedgerType(sceneType)
@ApiOperation(value = "鑾峰彇鐢ㄦ埛鏌愪釜鏃堕棿鐐逛笅搴旇鎻愪氦鐨勬墍鏈夊彴璐﹀強瀵瑰簲鐨勬彁浜ょ姸鎬併�佸鏍哥姸鎬佺瓑淇℃伅")
@GetMapping("/{userId}/summary")
fun getUserLedgerSummary(
- @ApiParam("鐢ㄦ埛id") @PathVariable userId: String,
- @ApiParam("鍦烘櫙绫诲瀷id") @RequestParam(value = "sceneType") sceneType: Int,
- @ApiParam(value = "鏃堕棿", example = "yyyy-MM-dd") @RequestParam(value = "time")time: String
+ @ApiParam("鐢ㄦ埛id") @PathVariable userId: String,
+ @ApiParam("鍦烘櫙绫诲瀷id") @RequestParam(value = "sceneType") sceneType: Int,
+ @ApiParam(value = "鏃堕棿", example = "yyyy-MM-dd") @RequestParam(value = "time")time: String
) = ledgerService.getUserLedgerSummary(userId, sceneType, time)
+ @ApiOperation(value = "鑾峰彇鍙拌处璇︽儏")
@GetMapping("/{userId}/detail")
fun getLedgerDetail(
- @PathVariable userId: String,
- @RequestParam(value = "ledgerSubTypeId", required = false) ledgerSubTypeId: Int?,
- @RequestParam(value = "sceneType") sceneType: Int,
- @RequestParam(value = "startTime") startTime: String,
- @RequestParam(value = "endTime") endTime: String,
- @RequestParam(value = "page", required = false) page: Int?,
- @RequestParam(value = "per_page") perPage: Int,
- response: HttpServletResponse
+ @ApiParam("鐢ㄦ埛id") @PathVariable userId: String,
+ @ApiParam("鍙拌处绫诲瀷id") @RequestParam(value = "ledgerSubTypeId", required = false) ledgerSubTypeId: Int?,
+ @ApiParam("鍦烘櫙绫诲瀷id") @RequestParam(value = "sceneType") sceneType: Int,
+ @ApiParam("涓婁紶寮�濮嬫椂闂�") @RequestParam(value = "startTime") startTime: String,
+ @ApiParam("涓婁紶缁撴潫鏃堕棿") @RequestParam(value = "endTime") endTime: String,
+ @ApiParam("椤电爜") @RequestParam(value = "page", required = false) page: Int?,
+ @ApiParam("鍗曢〉鏁版嵁閲�") @RequestParam(value = "per_page") perPage: Int,
+ response: HttpServletResponse
) = ledgerService.getLedgerDetail(userId, ledgerSubTypeId, sceneType, startTime, endTime, page, perPage, response)
@ApiOperation(value = "鑾峰彇鐢ㄦ埛鏌愮被鍙拌处璇︽儏鎴栬�呮墍鏈夊彴璐︾殑璇︽儏")
@GetMapping("/{userId}/detail2")
fun getLedgerDetail2(
- @ApiParam("鐢ㄦ埛id") @PathVariable userId: String,
- @ApiParam(value = "鍙拌处瀛愮被鍨媔d锛� 濡傛灉涓嶄紶锛屽垯榛樿鏍规嵁鍦烘櫙绫诲瀷鑾峰彇鎵�鏈夊彴璐�", required = false) @RequestParam(value = "ledgerSubTypeId", required = false) ledgerSubTypeId: Int?,
- @ApiParam("鍦烘櫙绫诲瀷id") @RequestParam(value = "sceneType") sceneType: Int,
- @ApiParam(value = "鏃堕棿", example = "yyyy-MM-dd") @RequestParam(value = "time") time: String
+ @ApiParam("鐢ㄦ埛id") @PathVariable userId: String,
+ @ApiParam(value = "鍙拌处瀛愮被鍨媔d锛� 濡傛灉涓嶄紶锛屽垯榛樿鏍规嵁鍦烘櫙绫诲瀷鑾峰彇鎵�鏈夊彴璐�", required = false) @RequestParam(value = "ledgerSubTypeId", required = false) ledgerSubTypeId: Int?,
+ @ApiParam("鍦烘櫙绫诲瀷id") @RequestParam(value = "sceneType") sceneType: Int,
+ @ApiParam(value = "鏃堕棿", example = "yyyy-MM-dd") @RequestParam(value = "time") time: String
) = ledgerService.getLedgerDetail2(userId, ledgerSubTypeId, sceneType, time)
+ @ApiOperation(value = "涓婁紶鍙拌处淇℃伅")
@PostMapping("/{userId}/upload")
fun uploadLedger(
- @PathVariable userId: String,
- @RequestParam("params") ledgerVoList: String,
- @RequestPart("images") files:Array<MultipartFile>
+ @ApiParam("鐢ㄦ埛id") @PathVariable userId: String,
+ @ApiParam("鍙拌处淇℃伅json") @RequestParam("params") ledgerVoList: String,
+ @ApiParam("鍙拌处鍥剧墖") @RequestPart("images") files:Array<MultipartFile>
) = ledgerService.uploadLedger(userId, ledgerVoList, files)
+ @ApiOperation(value = "鑾峰彇鏌愪釜鍙拌处鏄剧ず鍥炬爣url")
@GetMapping("/{userId}/img")
fun getLedgerImg(
- @PathVariable userId: String,
- @RequestParam("ledgerType") ledgerType: Int
+ @ApiParam("鐢ㄦ埛id") @PathVariable userId: String,
+ @ApiParam("鍙拌处绫诲瀷id") @RequestParam("ledgerType") ledgerType: Int
) = ledgerService.getLedgerImg(userId, ledgerType)
+ @ApiIgnore("璇ユ帴鍙ｆ湭浣跨敤锛岃�冭檻鍚庣画鍒犻櫎")
+ @ApiOperation(value = "鑾峰彇澶氫釜鍙拌处鍥炬爣淇℃伅")
@GetMapping("/{userId}/imgs")
fun getLedgerImgs(
- @PathVariable userId: String,
- @RequestParam("ledgerTypes") ledgerTypes: List<Int>
+ @ApiParam("鐢ㄦ埛id") @PathVariable userId: String,
+ @ApiParam("鍙拌处绫诲瀷id鏁扮粍") @RequestParam("ledgerTypes") ledgerTypes: List<Int>
) = ledgerService.getLedgerImgs(userId, ledgerTypes)
}
\ No newline at end of file
--
Gitblit v1.9.3