Swagger笔记

本文详细介绍了Swagger在SpringBoot项目中的集成过程,包括Swagger的介绍、前后端分离的概念,以及如何在SpringBoot中配置Swagger,实现API文档的在线自动生成和测试。通过调整配置,实现了在开发和生产环境下的不同启用状态,并且展示了如何创建API文档的分组。
摘要由CSDN通过智能技术生成

学习目标:

  • 了解Swagger的作用和概念
  • 了解前后端分离
  • 在SpringBoot中集成Swagger

Swagger简介

前后端分离

Vue + SpringBoot
后端时代:前端只用管理静态页面;html ⇒ 后端。模板引擎JSP ⇒ 后端是主力。

前后端分离时代:

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

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

    • 伪造后端数据,json。已经存在了,不需要后端,前端工程依旧能够跑起来。
  • 前后端如何交互? ===> API

  • 前后端相对独立,松耦合;

  • 前后端甚至可以部署在不同的服务器上;

产生一个问题:

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

解决方案:

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

  • 早些年:指定word计划文档;

  • 前后端分离:

    • 前端测试后端接口:postman
    • 后端提供接口,需要实时更新最新的消息及改动!

Swagger

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

官网:https://swagger.io/

在项目中使用swagger需要springbox;

  • swagger2
  • ui

SpringBoot集成Swagger

  1. 新建一个SpringBoot - web项目
  2. 导入相关依赖

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

打赏作者

LI JS@你猜啊

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

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

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

打赏作者

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

抵扣说明:

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

余额充值