首页 > 其他分享 >Swagger的基本使用(快速入门)

Swagger的基本使用(快速入门)

时间:2024-06-20 16:56:37浏览次数:14  
标签:Swagger 入门 配置 接口 文档 报错 springfox 快速

目录

一、环境配置

(1)导入依赖:(一般导入依赖都会报错,所以大家也可以借鉴一下这篇文章:swagger配置报错)

(2)启动类添加注解

二、Swagger配置介绍

(1)基本配置 

(2)设置扫描的包

三、Swagger常用注解

(1)@Api

(2)@ApiOperation

(3)@ApiParam

(4)@ApiModel

(5)@ApiIgnore

(6)@ApiImplicitParam


在使用Swagger前,首先我们要知道什么事Swagger。

接口文档对于前后端开发人员都十分重要。尤其近几年流行前后端分离后接口文档又变成重中之重。接口文档固然重要,但是由于项目周期等原因后端人员经常出现无法及时更新,导致前端人员抱怨接口文档和实际情况不一致。很多人员会抱怨别人写的接口文档不规范,不及时更新。如果接口文档可以实时动态生成就不会出现上面问题,Swagger可以完美地解决上面的问题。Swagger是一个规范和完整的框架,用于生成、描述、调用和可视化RESTful 风格的 Web 服务,可用于接口的文档在线自动生成以及功能测试。

我们一般都是通过springfox来使用Swagger

一、环境配置

(1)导入依赖:(一般导入依赖都会报错,所以大家也可以借鉴一下这篇文章:swagger配置报错

<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-swagger2</artifactId>
  <version>2.9.2</version>
</dependency>
<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-swagger-ui</artifactId>
  <version>2.9.2</version>
</dependency>

(2)启动类添加注解

@SpringBootApplication
@EnableSwagger2
public class MyApp {
    public static void main(String [] args){
        SpringApplication.run(MyApp.class,args);
    }
}

二、Swagger配置介绍

配置项         含义
Docket 摘要对象,通过对象配置描述文件的信息
apiInfo 设置描述文件中info,参数类型ApiInfo
select() 返回ApiSelectorBuilder对象,通过对象调用build()可以创建Docket对象
ApiInfoBuilder ApiInfo构建器

(1)基本配置 

@Configuration
public class SwaggerConfiguration {
    @Bean
    public Docket getDocket() {
        return new Docket(DocumentationType.SWAGGER_2)
   

标签:Swagger,入门,配置,接口,文档,报错,springfox,快速
From: https://blog.csdn.net/gaoqiandr/article/details/139825548

相关文章

  • Python 基础详解:入门宝典(3)
    容器类型介绍:1.列表(List)列表是Python中最常用的数据结构之一,它是一个有序的可变序列,允许存储任意类型的元素。列表用方括号[]表示。特点有序:元素按照插入顺序排列。可变:可以修改元素的值或增加、删除元素。支持重复:可以包含重复的元素。#创建一个列表fruits=['a......
  • HALCON-从入门到入门-相机标定-内参外参
    1.废话为什么要进行相机标定几个坐标系像素坐标系(图片坐标系)就是我们在电脑上看到图片的坐标系,以左上角为原点(2d坐标系)单位是像素pixel相机坐标系相机物方视野投影的坐标系,单位是mm世界坐标系就是真实的世界坐标系,单位是mm标定的结果标定的结果中有内参矩阵,外参,畸......
  • 软件测试入门基础03-MySQL
    前言:这是我个人的学习记录,我是科班在读有一定基础,很多东西不会特别详细,欢迎大佬指点,也很高兴有人看了能得到帮助这一小节的内容是MySQL,我已经修完数据库,但时间久远忘记许多于是又看了一遍做个笔记。印象中数据库挺简单,简单的说就是增删改查。我修这门课时把实验做完基本上知......
  • langchain入门
    LangChain为各种大型语言模型应用提供通用接口,从而简化应用程序的开发流程,轻松地构建如下所示的RAG应用 理解langchain的运作机制LangChain是一个为构建大型语言模型(LLMs)驱动的应用程序而设计的框架。它的核心目标是简化从开发到生产的整个应用程序生命周期。模块化构......
  • 初级冥想的入门方法:开启心灵之旅的第一步|流静
    冥想,这一古老的修行方式,如今在现代社会中焕发出新的活力。对于初学者而言,迈入冥想的大门似乎充满神秘与未知。然而,通过简单的入门方法,每个人都可以轻松开始这段心灵之旅。初级冥想的起步,在于寻找一个安静而舒适的空间。这个空间可以是家中的一角,也可以是公园里的长椅,......
  • 快速自定义表单开发受欢迎的几个优势
    为了满足业务需求,低代码技术平台带着更理想的优势特点,广泛用于各中大型企业中,是助力企业实现提质增效、提升开发效率的有力武器。那么,您知道快速自定义表单开发的优势体现在哪里吗?为了帮助大家了解这些详情,接下来将会为大家介绍低代码技术平台及快速自定义表单开发的优势,希望能给......
  • 电脑桌面文件夹删除不了怎么办?6种方法快速解决,建议收藏!
    桌面文件夹删不掉怎么办?有时会遇到桌面上的文件夹无法删除的问题,这是由于文件夹被系统进程或某些应用占用,或者是由于权限设置等原因造成的。以下是解决桌面文件夹无法删除问题的方法,帮助你有效地清理桌面环境。桌面文件夹删不掉,1、使用安全模式重启电脑;2、检查并修改权限设......
  • 快速上手搭建区块链,可以使用Scaffold-ETH脚手架
    一、Scaffold-eth是什么?Scaffold-eth是一个基于以太坊(Ethereum)的开源开发框架,专为构建去中心化应用(DApps)而设计。以下是对Scaffold-eth的详细解释:项目简介:Scaffold-eth由AustinGriffith创建,旨在简化以太坊智能合约和前端应用程序的开发过程。它为Web3开发者提供了一个集......
  • 免构建安装 nginx php-fpm 快速运行 php 项目
    文档说明:只记录关键地方;发布时间:2024-06-20需求:linux、macos环境下,免构建安装nginxphp-fpm快速运行php项目运行环境:linux、macos状态:已完成实现原理:静态编译nginx、php-fpm下载nginx、php-fpm脚本和运行时gitclonehttps://gitee.com/jingjingxy......
  • MySQL入门学习-连接查询.INNER JOIN
        表的连接在数据库中扮演着至关重要的角色。当我们处理多个表之间的关联数据时,连接查询是必不可少的。    假设我们有两个表A和B,它们有一个共同的字段。现在,我们想从A和B中选择出所有匹配的数据。这就是连接查询的作用。    以下是一个基本的......