狂神Swagger笔记(Swagger轻松入门)

SpringBoot集成Swagger:实时生成API文档与接口测试指南
本文详细介绍了如何在SpringBoot项目中集成Swagger,包括引入库、配置Swagger、扫描接口、文档注解,并提供了实际操作步骤和注意事项,帮助开发者快速生成API文档并进行在线测试。


前言

说起Swagger就不得不说前后端分离

当前最主流的前后端分离技术栈:Vue+Springboot

后端时代:

前端只用管理静态页面:html

最后统一交给后端,后端将其修改为jsp,在整个过程中,后端充当主力

前后端分离时代:

后端:后端控制层,服务层,数据访问层【后端团队】

前端:前端控制层,视图层【前端团队】

前端可以自定义一些伪后端数据:json,在写的时候就存在,不需要后端,前端工程依旧能够跑起来

那么前端后端如何交互?
此时我们可以考虑API

前后端分离好处:

  • 前后端相对独立,松耦合
  • 前后端设置可以部署在不同的服务器上

产生的问题:

  • 前后弹集成联调,前端人员和后端人员无法做到及时协商,尽早解决,最终导致问题爆发;

解决方式:

  • 首先指定schema[计划的提纲],实时更新最新的API,降低集成风险

  • 早期:指定word计划文档

  • 前后端分离时期:

    前端测试后端接口:postman

    后端提供接口,需要实时更新最新的消息及改动

一、Swagger

  • 号称世界上最流行的Api框架
  • RestFul Api 文档在线自动生成工具,Api文档与Api定义同步更新
  • 直接运行,可以在线测试API接口
  • 支持多种语言:(Java,php等)

官网:http://swagger.io/

二、SpringBoot集成Swagger

1.引入库

2.导入依赖

  • swagger2

  • ui

<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>

3.配置Swagger

@EnableSwagger2 用来开启Swagger2

@Configuration
@EnableSwagger2 //开启Swagger2
public class SwaggerConfig {
   
   

}

4.进入测试

http://localhost:8080/swagger-ui.html

在这里插入图片描述


# 配置Swagger基本信息 **Swagger的Bean实例Docket:**
package com.kuang.swagger.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web
评论 3
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

温文艾尔

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值