Swagger2 与 springmvc 集成实现API文档化

2024-03-14 15:32

本文主要是介绍Swagger2 与 springmvc 集成实现API文档化,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

为什么要实现API文档化?

  1. API文档化有利于前后端分离的开展。随着开发方式全面转成前后端分离,前端和后端的唯一沟通就在API层面。在没有文档化之前,开发人员只能口头的交代并反复理解每个接口参数和返回值,这个过程相当不稳定,变化频繁。而通过API文档化后,可以通过文档的清晰定义,使得前后端人员减少无畏沟通,并在理解上保持一致;

  2. API文档化有利于接口自动化测试。公司马上上马接口自动化测试,对接口参数和返回值要通过Json方式导入自动化测试程序。而用特殊工具生成的API文档,可以直接输出json格式的文档,简化了测试流程,减轻了开发人员的工作量;

  3. API文档化有利于系统文档建设。开发人员不愿意写文档,写注释。而为了以上两个目的必须要求开发人员在编码的同时补充相关的API描述,而通过一个相对稳定成熟和趁手的工具可以大大减轻文档的工作量,做到事半功倍。

Swagger和spring-boot-starter-swagger

Swagger是业界比较流行的实现API文档化的工具。优点有

  1. 通过在项目中引入Swagger,可以使用简单的Annotation,就实现了API文档化;
  2. Swagger提供标准的json或yaml文档,方便做进一步解析,典型应用是接口自动化测试;
  3. 页面可以直接进行测试(try-it-out功能,部分替代Postman);
  4. Swagger还提供类似于github的SwaggerHub,相当于公共的API文档集散地。

Swagger的项目主页:https://swagger.io/


搭建和使用 可以参考以下网址:

微服务之Swagger :https://www.cnblogs.com/softidea/p/6251249.html 


SpringBoot学习笔记之集成swagger : http://blog.csdn.net/liyuejin/article/details/78036582


springfox github : https://github.com/springfox/springfox

springfox &Swagger2的API

http://springfox.github.io/springfox/docs/current/#springfox-spring-mvc-and-spring-boot


这篇关于Swagger2 与 springmvc 集成实现API文档化的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/808853

相关文章

JVM 的类初始化机制

前言 当你在 Java 程序中new对象时,有没有考虑过 JVM 是如何把静态的字节码(byte code)转化为运行时对象的呢,这个问题看似简单,但清楚的同学相信也不会太多,这篇文章首先介绍 JVM 类初始化的机制,然后给出几个易出错的实例来分析,帮助大家更好理解这个知识点。 JVM 将字节码转化为运行时对象分为三个阶段,分别是:loading 、Linking、initialization

Spring Security 基于表达式的权限控制

前言 spring security 3.0已经可以使用spring el表达式来控制授权,允许在表达式中使用复杂的布尔逻辑来控制访问的权限。 常见的表达式 Spring Security可用表达式对象的基类是SecurityExpressionRoot。 表达式描述hasRole([role])用户拥有制定的角色时返回true (Spring security默认会带有ROLE_前缀),去

浅析Spring Security认证过程

类图 为了方便理解Spring Security认证流程,特意画了如下的类图,包含相关的核心认证类 概述 核心验证器 AuthenticationManager 该对象提供了认证方法的入口,接收一个Authentiaton对象作为参数; public interface AuthenticationManager {Authentication authenticate(Authenti

Spring Security--Architecture Overview

1 核心组件 这一节主要介绍一些在Spring Security中常见且核心的Java类,它们之间的依赖,构建起了整个框架。想要理解整个架构,最起码得对这些类眼熟。 1.1 SecurityContextHolder SecurityContextHolder用于存储安全上下文(security context)的信息。当前操作的用户是谁,该用户是否已经被认证,他拥有哪些角色权限…这些都被保

Spring Security基于数据库验证流程详解

Spring Security 校验流程图 相关解释说明(认真看哦) AbstractAuthenticationProcessingFilter 抽象类 /*** 调用 #requiresAuthentication(HttpServletRequest, HttpServletResponse) 决定是否需要进行验证操作。* 如果需要验证,则会调用 #attemptAuthentica

Spring Security 从入门到进阶系列教程

Spring Security 入门系列 《保护 Web 应用的安全》 《Spring-Security-入门(一):登录与退出》 《Spring-Security-入门(二):基于数据库验证》 《Spring-Security-入门(三):密码加密》 《Spring-Security-入门(四):自定义-Filter》 《Spring-Security-入门(五):在 Sprin

Java架构师知识体认识

源码分析 常用设计模式 Proxy代理模式Factory工厂模式Singleton单例模式Delegate委派模式Strategy策略模式Prototype原型模式Template模板模式 Spring5 beans 接口实例化代理Bean操作 Context Ioc容器设计原理及高级特性Aop设计原理Factorybean与Beanfactory Transaction 声明式事物

Java进阶13讲__第12讲_1/2

多线程、线程池 1.  线程概念 1.1  什么是线程 1.2  线程的好处 2.   创建线程的三种方式 注意事项 2.1  继承Thread类 2.1.1 认识  2.1.2  编码实现  package cn.hdc.oop10.Thread;import org.slf4j.Logger;import org.slf4j.LoggerFactory

hdu1043(八数码问题,广搜 + hash(实现状态压缩) )

利用康拓展开将一个排列映射成一个自然数,然后就变成了普通的广搜题。 #include<iostream>#include<algorithm>#include<string>#include<stack>#include<queue>#include<map>#include<stdio.h>#include<stdlib.h>#include<ctype.h>#inclu

JAVA智听未来一站式有声阅读平台听书系统小程序源码

智听未来,一站式有声阅读平台听书系统 🌟&nbsp;开篇:遇见未来,从“智听”开始 在这个快节奏的时代,你是否渴望在忙碌的间隙,找到一片属于自己的宁静角落?是否梦想着能随时随地,沉浸在知识的海洋,或是故事的奇幻世界里?今天,就让我带你一起探索“智听未来”——这一站式有声阅读平台听书系统,它正悄悄改变着我们的阅读方式,让未来触手可及! 📚&nbsp;第一站:海量资源,应有尽有 走进“智听