前言技术之swagger，Dubbo高频面试题+解析

②、编写swagger的配置类

注意： 该配置类需要根据自己的项目修改，如以下配置

paths 指定需要生成文档的url规则

title 文档标题

description 描述

package com.lv.code.config;

import org.springframework.context.annotation.Bean;

import org.springframework.context.annotation.Configuration;

import org.springframework.web.bind.annotation.RestController;

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;

@Configuration

@EnableSwagger2

public class SwaggerConfig {

@Bean

public Docket createRestApi() {

return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())

.select()

// 请求处理选择器,扫描controller层

.apis(RequestHandlerSelectors.basePackage(“com.lv.code.controller”))

// 上面包内的所有请求

.paths(PathSelectors.any())

.build();

}

//api简介

private ApiInfo apiInfo() {

return new ApiInfoBuilder()

.title(“l蹦跶v”)

.description(“SwaggerDemo API DOC”)

.version(“1.0”)

.termsOfServiceUrl(“https://www.bd.com”)

.build();

}

}

启动进入：

在controller层方法内指定提交方法：

@RequestMapping(“/login”,method= RequestMethod.POST)

public ResponseResult<?> login(@RequestBody User user){

return userService.findUserByAccount(user);

}

可以尝试连接：

填完数据连接：

访问成功：

---

3、swagger常用注解

---

注解	位置	作用	参数
@Api	类	标识这个类是swagger的资 源	源 tags：说明该类的作用，参数是个数组，可以填多个。
value="该参数没什么意 义，在UI界面上不显示，所以不用配置"
description = "用户基本信息操作"
@ApiOperation	方法	表示一个http请求的操作	value="方法的用途和作 用"
notes="方法的注意事项和备注"
tags：说明该方法的作用， 参数是个数组，可以填多 个。
格式：tags={"作用1","作用2"}
@ApiParam	方法， 参数	对参数使用说明（如：说明 或是否必填等）	value="用户名" 描述参数的意义
name="name" 参数的变量名
required=true 参数是否必选
@ApiModel	类	表示对类进行说明，用于参 数用实体类接收，一般用在DTO上	description="描述实体的作用"
@ApiModelProperty	方 法， 字段	表示对model属性的说明	value="用户名" 描述参数的意义
name="name" 参数的变量名
required=true 参数是否必选
@ApiIgnore	类， 方 法， 参数	表示这个方法或者类被忽略	无
@ApiImplicitParams	方法	包含多@ApiImplicitParam
@ApiImplicitParam	方法	表示单独的请求参数	name="参数名称"
value="参数说明"
dataType="数据类型"
paramType="query" 表示 参数放在哪里

header 请求参数的获取：@RequestHeader

query  请求参数的获取：@RequestParam

path（用于restful接口） 请求参数的获取：@PathVariable

body（不常用）

form（不常用）

defaultValue=" 参数的默认值 "

required=“true” 表示参数是否必须传 |

更全面的信息可以参考官方说明文档：

swagger-annotations 1.3.10 API

例如：

package com.lv.code.controller;

import com.lv.code.pojo.User;

import com.lv.code.service.IuserService;

import com.lv.code.util.response.ResponseResult;

import io.swagger.annotations.Api;

import io.swagger.annotations.ApiImplicitParam;

import io.swagger.annotations.ApiOperation;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.scheduling.annotation.Async;

import org.springframework.web.bind.annotation.RequestBody;

import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.web.bind.annotation.RequestMethod;

import org.springframework.web.bind.annotation.RestController;

@RestController

@RequestMapping(“/user”)

@Api(tags = “用户操作类”)

public class UserController {

@Autowired

private IuserService userService;

@ApiOperation(value = “登录方法”)

@ApiImplicitParam(value=“user”,required = true,name = “用户信息”,paramType = “body”)

@RequestMapping(value=“/login”,method= RequestMethod.POST)

public ResponseResult<?> login(@RequestBody User user){

return userService.findUserByAccount(user);

}

小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数初中级Java工程师，想要提升技能，往往是自己摸索成长，但自己不成体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！

因此收集整理了一份《2024年最新Java开发全套学习资料》送给大家，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频

如果你觉得这些内容对你有帮助，可以添加下面V无偿领取！（备注Java）

架构学习资料

由于篇幅限制小编，pdf文档的详解资料太全面，细节内容实在太多啦，所以只把部分知识点截图出来粗略的介绍，每个小节点里面都有更细化的内容！

存中…(img-1QI0KIHP-1711100906084)]

[外链图片转存中…(img-db3cvsRE-1711100906084)]

[外链图片转存中…(img-LjSvaHMY-1711100906085)]

[外链图片转存中…(img-re5vKIva-1711100906085)]

[外链图片转存中…(img-g3Ywnvb7-1711100906085)]

由于篇幅限制小编，pdf文档的详解资料太全面，细节内容实在太多啦，所以只把部分知识点截图出来粗略的介绍，每个小节点里面都有更细化的内容！

本文已被CODING开源项目：【一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码】收录