添加swagger，实现接口文档

最新推荐文章于 2024-09-25 11:06:23 发布

Niliuershangba

最新推荐文章于 2024-09-25 11:06:23 发布

阅读量257

点赞数 10

文章标签： java tomcat maven spring mybatis

本文链接：https://blog.csdn.net/kwb18293575696/article/details/141174130

版权

先添加这个依赖

<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
    <version>3.0.3</version>
</dependency>

然后在controller层实现例如：

package com.itcast.controller;


import cn.hutool.core.util.StrUtil;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.itcast.domain.PageDTO;
import com.itcast.domain.dto.ItemDTO;
import com.itcast.domain.po.Item;
import com.itcast.domain.query.ItemPageQuery;
import com.itcast.service.IItemService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@Api(tags = "搜索相关接口")
@RestController
@RequestMapping("/search")
@RequiredArgsConstructor
public class SearchController {

    private final IItemService itemService;

    @ApiOperation("搜索商品")
    @GetMapping("/list")
    public PageDTO<ItemDTO> search(ItemPageQuery query) {
        // 分页查询
        Page<Item> result = itemService.lambdaQuery()
                .like(StrUtil.isNotBlank(query.getKey()), Item::getName, query.getKey())
                .eq(StrUtil.isNotBlank(query.getBrand()), Item::getBrand, query.getBrand())
                .eq(StrUtil.isNotBlank(query.getCategory()), Item::getCategory, query.getCategory())
                .eq(Item::getStatus, 1)
                .between(query.getMaxPrice() != null, Item::getPrice, query.getMinPrice(), query.getMaxPrice())
                .page(query.toMpPage("update_time", false));
        // 封装并返回
        return PageDTO.of(result, ItemDTO.class);
    }
}

最后：访问地址为：（端口号为自己项目启动所用的端口）黑马商城接口文档http://localhost:8080/doc.html#/home