Spring 集成 Swagger

Swagger 是一个规范且完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务

Swagger 的目标是对 REST API 定义一个标准且和语言无关的接口,可以让人和计算机拥有无须访问源码、文档或网络流量监测就可以发现和理解服务的能力。当通过 Swagger 进行正确定义,用户可以理解远程服务并使用最少实现逻辑与远程服务进行交互。与为底层编程所实现的接口类似,Swagger 消除了调用服务时可能会有的猜测

Swagger 的优势

支持 API 自动生成同步的在线文档:使用 Swagger 后可以直接通过代码生成文档,不再需要自己手动编写接口文档了,对程序员来说非常方便,可以节约写文档的时间去学习新技术

提供 Web 页面在线测试 API:光有文档还不够,Swagger 生成的文档还支持在线测试。参数和格式都定好了,直接在界面上输入参数对应的值即可在线测试接口

现有项目使用的是spring框架 现需要集成Swagger,步骤如下:

1.添加依赖

2.创建 Swagger 配置类

3.在spring.xml 增加扫描配置

4.后续就可以在controller和entity中 增加注解生成API文档

5.在配置文件中配置开关:swagger.enabled=true 测试环境打开 生产环境关闭

就可以启动项目 访问:http://localhost:8080/项目名/swagger-ui.html 查看api

Original: https://www.cnblogs.com/qinxu/p/14676604.html
Author: 【cosmo】
Title: Spring 集成 Swagger

原创文章受到原创版权保护。转载请注明出处:https://www.johngo689.com/540807/

转载文章受原作者版权保护。转载请注明原作者出处!

(0)

大家都在看

  • Java定时器Timer和TimerTask

    方式一:设定指定任务task在指定时间time执行 schedule(TimerTask task, Date date) public static void main (Str…

    Java 2023年6月15日
    074
  • 使用Spring容器动态注册和获取Bean

    有时候需要在运行时动态注册Bean到Spring容器,并根据Bean名称或者类型获取注册的Bean。本文旨在介绍通过Spring容器获得这个能力。 有时候需要在运行时动态注册Bea…

    Java 2023年6月5日
    086
  • Java方法和数组

    方法 什么是方法 Java方法是语句的集合,它们在一起执行一个功能。 方法是解决一类问题的步骤的有序组合 方法包含于类或对象中 方法在程序中被创建,在其他地方被引用 设计方法的原则…

    Java 2023年6月5日
    0102
  • Jni 线程JNIEnv,JavaVM,JNI_OnLoad(GetEnv返回NULL?FindClass返回NULL?)

    此文章是关于NDK线程的第二篇理论知识笔记。主要有两个点,如下: 1.pthread_create(Too many arguements, expected 1) ?2.线程中如…

    Java 2023年5月29日
    072
  • POI完成Excel文件的读和写

    简介 Apache POI 是用Java编写的免费开源的跨平台的 Java API,Apache POI提供API给Java程式对Microsoft Office(Excel、WO…

    Java 2023年6月16日
    076
  • 动力节点-王妈妈Springboot教程(六)Redis

    *官方下载地址:动力节点官网 *视频观看地址 Redis : 一个NoSQL数据库, 常用作缓存使用 (cache) Redis的数据类型: string , hash ,set …

    Java 2023年6月7日
    078
  • h5中的分组元素figure、figcaption、hgroup元素介绍

    分组元素用于对页面中的内容进行分组。 figure元素和figcaption元素 figure元素用于定义独立的流内容(图像、图表、照片、代码等),一般指一个独立的单元。 figu…

    Java 2023年6月7日
    067
  • Elasticsearch学习

    1 Elasticsearch 概述 Elaticsearch,简称为 ES,ES 是一个开源的高扩展的分布式全文搜索引擎,是整个 Elastic Stack 技术栈的核心。它可以…

    Java 2023年6月5日
    088
  • Java高并发教程:Future异步回调模式

    Netty和Guava一样,实现了自己的异步回调体系: Netty继承和扩展了JDK Future系列异步回调的API,定义了自身的Future系列接口和类,实现了异步任务的监控、…

    Java 2023年5月29日
    065
  • Maven 快速入门

    一、简介 Maven 是一个用于构建/管理任何基于Java项目的工具,其本身也是基于Java的 因此需要Java环境。其最初是为了简化 Jakarta Turbine 项目的构建而…

    Java 2023年6月6日
    067
  • 描述性统计

    Part2 描述性统计 一、直方图 直方图是用面积而不是用高度来表示数,所以其不同于条形图 左边的刻度表示该块 每单位所占总面积的百分比,可以称其为 密度尺度。例如以每50元为一个…

    Java 2023年6月7日
    079
  • 设计模式之单例模式

    1、什么是单例模式 ​ 单例模式是指保证 某个类在整个软件系统中只有一个对象实例,并且该类仅提供一个返回其对象实例的方法(通常为静态方法) 2、单例模式的种类 ​ 经典的单例模式实…

    Java 2023年6月8日
    068
  • MCU软件最佳实践——使用printf打印数据

    在mcu上开发应用时,使用串口打印调试信息是最常用的调试手段之一。printf是c标准库提供的函数,可以方便输出格式化的信息。但针对不同的mcu芯片,printf函数要能正常工作,…

    Java 2023年6月6日
    0114
  • java算法-选择排序

    选择排序算法特点: 每一轮找出一个最小值或者最大值,依次放在最前面的位置。在查找的过程中,用当前假定的最小值或者最大值,去跟后面所有的值进行比较。如果小或者大,就把下标给那个假定的…

    Java 2023年5月29日
    073
  • 【Unity Shader学习笔记】Unity光照-阴影

    1、原理 由一个物体向其他物体投射阴影,以及一个物体如何接收其他物体的阴影。 实时渲染中经常使用 Shadow Map 技术。它会首先把摄像机的位置放在与光源重合的位置上, 那么场…

    Java 2023年6月9日
    076
  • Node版本更新及切换

    Node版本升级 清除npm缓存 npm cache clean -f n&#x6A…

    Java 2023年6月8日
    079
亲爱的 Coder【最近整理,可免费获取】👉 最新必读书单  | 👏 面试题下载  | 🌎 免费的AI知识星球