1. 接口文档自动输出

riku

2022-06-09 9867f6d5c5bccfe52b878c344c536905dd6b309e

 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,9 +17,10 @@
@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 = "获取用户某个时间点下应该提交的所有台账及对应的提交状态、审核状态等信息")
@@ -29,15 +31,16 @@
            @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,
        @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)

@@ -50,22 +53,26 @@
            @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)
}