代码编织梦想

Swagger-UI

Swagger-UI是HTML, Javascript, CSS的一个集合,可以动态地根据注解生成在线API文档。

常用注解

  • @Api:用于修饰Controller类,生成Controller相关文档信息
  • @ApiOperation:用于修饰Controller类中的方法,生成接口方法相关文档信息
  • @ApiParam:用于修饰接口中的参数,生成接口参数相关文档信息
  • @ApiModelProperty:用于修饰实体类的属性,当实体类是请求参数或返回结果时,直接生成相关文档信息

整合Swagger-UI

在pom.xml中新增Swagger-UI相关依赖

	<!--Swagger-UI API文档生产工具-->
	<dependency>
	  <groupId>io.springfox</groupId>
	  <artifactId>springfox-swagger2</artifactId>
	  <version>2.7.0</version>
	</dependency>
	<dependency>
	  <groupId>io.springfox</groupId>
	  <artifactId>springfox-swagger-ui</artifactId>
	  <version>2.7.0</version>
	</dependency>

添加Swagger-UI的配置

Swagger对生成API文档的范围有三种不同的选择

  • 生成指定包下面的类的API文档
  • 生成有指定注解的类的API文档
  • 生成有指定注解的方法的API文档

注意 :

添加注解 @EnableSwagger2, @Configuration

package com.macro.mall.tiny.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * Swagger2API文档的配置
 */
@Configuration
@EnableSwagger2
public class Swagger2Config {
    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //为当前包下controller生成API文档
                .apis(RequestHandlerSelectors.basePackage("com.macro.mall.tiny.controller"))
                //为有@Api注解的Controller生成API文档
//                .apis(RequestHandlerSelectors.withClassAnnotation(Api.class))
                //为有@ApiOperation注解的方法生成API文档
//                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("SwaggerUI演示")
                .description("mall-tiny")
                .contact("macro")
                .version("1.0")
                .build();
    }
}

给Controller类添加Swagger注解

package com.macro.mall.tiny.controller;

import com.macro.mall.tiny.common.api.CommonPage;
import com.macro.mall.tiny.common.api.CommonResult;
import com.macro.mall.tiny.mbg.model.PmsBrand;
import com.macro.mall.tiny.service.PmsBrandService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.validation.BindingResult;
import org.springframework.web.bind.annotation.*;

import java.util.List;

@Api(tags = "PmsBrandController", description = "商品品牌管理")
@Controller
@RequestMapping("/brand")
public class PmsBrandController {
    @Autowired
    private PmsBrandService brandService;

    private static final Logger LOGGER = LoggerFactory.getLogger(PmsBrandController.class);

    @ApiOperation("获取所有品牌列表")
    @RequestMapping(value = "listAll", method = RequestMethod.GET)
    @ResponseBody
    public CommonResult<List<PmsBrand>> getBrandList() {
        ...
    }

    @ApiOperation("添加品牌")
    @RequestMapping(value = "/create", method = RequestMethod.POST)
    @ResponseBody
    public CommonResult createBrand(@RequestBody PmsBrand pmsBrand) {
        ...
    }

    @ApiOperation("更新指定id品牌信息")
    @RequestMapping(value = "/update/{id}", method = RequestMethod.POST)
    @ResponseBody
    public CommonResult updateBrand(@PathVariable("id") Long id, @RequestBody PmsBrand pmsBrandDto, BindingResult result) {
       ...
    }

    @ApiOperation("删除指定id的品牌")
    @RequestMapping(value = "/delete/{id}", method = RequestMethod.GET)
    @ResponseBody
    public CommonResult deleteBrand(@PathVariable("id") Long id) {
       ....
    }
 	@ApiOperation("分页查询品牌列表")
    @RequestMapping(value = "/list", method = RequestMethod.GET)
    @ResponseBody
    public CommonResult<CommonPage<PmsBrand>> listBrand(@RequestParam(value = "pageNum", defaultValue = "1")
                                                        @ApiParam("页码") Integer pageNum,
                                                        @RequestParam(value = "pageSize", defaultValue = "3")
                                                        @ApiParam("每页数量") Integer pageSize) {
        ...
    }
                  
}

启动项目,查看Swagger-UI文档

接口地址:http://localhost:8080/swagger-ui.html

在这里插入图片描述

参考文档

mall整合Swagger-UI实现在线API文档

版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。 本文链接: https://blog.csdn.net/weixin_41314389/article/details/104859693

Java基础---死锁编码及定位-爱代码爱编程

文章目录 一、死锁是什么二、什么情况下会产生死锁三、解决方法 一、死锁是什么 死锁是两个或两个以上的进程在执行过程中,因争夺资源而造成的一种互相等待的现象。 死锁产生的主要原因: (1)系统资源不足 (2)进程运行推进的顺序不合适 (3)资源分配不当 二、什么情况下会产生死锁 package com.interview.javabasi

运用HOG通过Java和C ++实现面部识别比较-爱代码爱编程

全文共8470字,预计学习时长25分钟   来源:xaecong   HOG:梯度方向直方图(histogram of orientedgradients)是一种图片描述符格式,它能够汇总图像(例如人脸)的主要特征,从而与相似图像进行比较。 本文以及教程源于两年前,我决定更新源代码使其现代化并再次发布。   Java/C++

Java基础---线程池核心知识总结-爱代码爱编程

文章目录 一、线程池如何使用1、架构说明2、编码实现3、ThreadPoolExecutor二、线程池的底层工作原理1、线程池的重要参数(1)corePoolSize(2)maximumPoolSize(3)keepAliveTime(4)unit(5)workQueue(阻塞队列)(6)threadFactory(7)handler2、线程池工作

Spring Boot统一异常处理,捕获404异常,并进行响应处理-爱代码爱编程

为了让用户体验更好,我们经常会在后台自动捕获异常并作出相应的反馈,而不让用户直接看到404或500这样的报错页面! 下面就贴出一个简单的统一异常捕获类! 1、配置application.yml文件 spring: MVC: #出现错误时, 直接抛出异常 throw-exception-if-no-handler-found: true

Redis中消息队列/发布和订阅的介绍及代码实现-爱代码爱编程

一、概念 发布订阅是一种应用程序(系统)之间的通讯 传递数据的技术手段 特别是在异构(不同语言)的系统之间作用非常明显 发布订阅可以实现应用(系统)之间的解耦合 类似于微信中关注公众号/订阅号 那么订阅者能及时获取到最新的内容 或者微博的订阅也是类似 日常生活中听广播 看电视 都需要有信息的发布者 收听的人需要先订阅 发布和订阅是一对多的关系 订阅

深入理解JVM第六章笔记-爱代码爱编程

深入理解JVM第六章笔记 无关性 字节码,各种不同的平台的虚拟机与所有平台都统一使用的程序存储格式,它也是构成Java语言平台无关性的基石。 Java虚拟机不和包括Java在内的任何语言绑定,它只与“Class文件”这种特定的二进制文件格式所关联。Class文件包含了Java虚拟机指令集和符号表以及若干其他辅助信息。 Class类文件的结构 cl

SpringBoot集成MyBatis的分页插件PageHelper-爱代码爱编程

【写在前面】 项目的后台管理系统需要展示所有资源信息,select * 虽然方便但数据量过于庞大会严重降低查找效率,页面加载慢,用户体验差。分页自然是必要选择,但原生的方法过于繁杂。MyBatis的分页插件PageHelper和SpringBoot的集成是更好的选择,它的使用非常简单,开发更为高效。 代码如下 一、pom文件导入依赖 <dep

Elasticsearch-ais使用方式-爱代码爱编程

Elasticsearch-ais是我新写的Elasticsearch框架(或者也可以称之为springboot组件),他的操作方式非常简单,比现有的Elasticsearch操作方式都简单,希望大家可以使用 导入 <dependency> <groupId>com.github.lihan

springboot前后端分离项目MultipartFile获取前端传的file为null问题-爱代码爱编程

【问题描述】 springboot+vue 前后端分离项目,在对接上传文件功能时,一直显示文件为空。 【分析】 查找了很多博客,解决方法五花八门,但原因应该还是 springboot自带的org.springframework.web.multipart.MultipartFile和Multipart冲突。 所以使用 @EnableAutoConfi

【SpringBoot】Spring Boot 与 RabbitMQ-爱代码爱编程

一、Spring AMQP 简介   原文           Spring AMQP项目将Spring的核心概念应用于基于AMQP的消息传递解决方案的开发。它提供了一个“模板”作为用于发送和接收消息的高级抽象。它还通过“侦听器容器”为消息驱动的POJO提供支持。这些库促进了AMQP资源的管理,同时促进了对依赖项注入和声明性配置的使用。在所有这

springboot 基础入门-爱代码爱编程

1、idea 新建一个项目,https://blog.csdn.net/huangwenyi1010/article/details/55047138 2、下载maven,解压maven,idea  --file---setting--- mvave(路径,setting.xml , 新建一个项目jar包存放的仓库地址) 点击右侧刷新下载project

微信开发02-微信公众号授权登录-爱代码爱编程

目录 准备工作 1、注册个人账号 1.1、注册地址 2、申请测试账号 2.1测试账号位置: 2.2、点击公众平台测试账号 2.3、测试账号拥有的权限 3、微信测试账号上的配置 3.1、接口配置信息 3.2、授权回调页面域名修改 4、授权登录开发 4.1、编写前端授权登录页面 4.2、编写授权成功的回调接口 4.3、后端回调接口