SpringCloud/SpringBoot 的项目一定要前后分离,这就需要一个API文档生成的工具,后端一定要和前端或者是移动端对接接口,那么问题来了,接口是不是要自己写给他们看,一般的会采用Excel或者Word来写,高级一点的就采用API管理平台手工录入,一个项目有上千上万个接口,天啊,这是多么大的工作量,在接口维护的时候更加痛苦,为了解决这样的事我们可以借助 japi 这个项目来完成RES
转载 2024-07-24 11:34:56
180阅读
一、先添加 Swagger2 所需要的依赖包<!--swagger2接口文档--> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <v
转载 2024-05-14 22:10:54
809阅读
前言通过之前的两篇关于Swagger入门以及具体使用细节的介绍之后,我们已经能够轻松地为Spring MVC的Web项目自动构建出API文档了。在这两篇文章中,我们构建的文档必须通过在项目中整合swagger-ui、或使用单独部署的swagger-ui和/v2/api-docs返回的配置信息才能展现出您所构建的API文档。而有些时候,我们可能只需要提供静态文档给其他对接方的时候,我们要如何快速轻便
由于Spring Boot能够快速开发、便捷部署等特性,相信有很大一部分Spring Boot的用户会用来构建RESTful API。而我们构建RESTful API的目的通常都是由于多终端的原因,这些终端会共用很多底层业务逻辑,因此我们会抽象出这样一层来同时服务于多个移动端或者Web前端。这样一来,我们的RESTful API就有可能要面对多个开发人员或多个开发团队:IOS开发、Android开
转载 2024-10-11 10:41:58
125阅读
零、前言接口文档在项目开发中是非常重要的,是前后端协同开发的有力武器,如果没有一个良好 的接口文档来给相关开发人员查看接口的情况(或者变化),那么前后端的开发工作耦合程度(指的是需要经常询问接口情况)将会严重增加。一、swagger简介Swagger是一款Restful接口文档在线自动生成和功能测试功能软件。 Swagger是一个规范和完整的框架,用于生成、描述、调用和可视化
转载 2024-03-15 19:10:17
174阅读
1、Swagger 简介1.1、Swagger 是什么?Swagger 是一款 RESTful 接口文档在线生成软件Swagger 是一款 RESTful 接口的功能测试软件Swagger 是一座前后端开发者沟通的桥梁Swagger 是一个规范且完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。Swagger 的目标是对 REST API 定义一个标准且和语言无关的
Swagger2Swagger2简介1. 整合 Spring Boot2. 创建 Swagger 2 的配置类3. 创建 controller 的接口User 实体类代码如下:4. 启动项目,进行测试结语 Swagger2简介通常在前后端开发中,为了减少一些沟通成本,一般都会构建一份 RESTful API 文档来描述所有的接口信息 Swagger 2 是一个开源软件框架,可以帮助开发人员设计、
转载 2023-10-02 11:20:40
270阅读
之前我在SpringBoot老鸟系列中专门花了大量的篇幅详细介绍如何集成Swagger,以及如何对Swagger进行扩展让其支持接口参数分组功能。可是当我接触到另一个接口文档工具smart-doc后,我觉得它比Swagger更适合集成在项目中,更适合老鸟们。今天我们就来介绍一下smart-doc组件的使用,作为对老鸟系列文章的一个补充。一、swagger vs smart-doc首先我们先看一下S
转载 2023-11-16 21:30:12
388阅读
JApiDocs是一个无需额外注解、开箱即用的SpringBoot接口文档生成工具。前言编写和维护API文档,对于后端程序员来说,是一件恼人但又不得不做的事情,我们都不喜欢写文档,除非项目前后端代码都是自己写的,否则API文档将是前后端协作不可或缺的沟通载体。 最佳实践是:先把接口设计好,在Mock的方法上写注释来生成API文档,这样做到前后端根据API文档并行开发。为什么引入JApiDocs相比
转载 2024-03-01 21:24:46
71阅读
JApiDocs是一个无需额外注解、开箱即用的SpringBoot接口文档生成工具。编写和维护API文档这个事情,对于后端程序员来说,是一件恼人但又不得不做的事情,我们都不喜欢写文档,但除非项目前后端代码都是自己写的,否则API文档将是前后端协作中一个不可或缺的沟通界面。既然不可避免,那就想办法弄个轮子吧。人生苦短,必须偷懒。无图无真相,生成文档的效果如下: img 相比Sw
转载 2024-07-03 11:26:15
377阅读
相信各位在公司写API文档数量应该不少,当然如果你还处在自己一个人开发前后台的年代,当我没说,如今为了前后台更好的对接,还是为了以后交接方便,都有要求写API文档。该demo完整的代码已经上传到github上,如有需要,请自行clone。https://github.com/jiangheng88/springboot-mybatisplus-swagger一、描述首先说一下swagger的两个主
转载 2024-02-20 17:04:34
197阅读
application.yml spring: datasource: driver-class-name: com.mysql.cj.jdbc.Driver url: jdbc:mysql://localhost:3306/test?useUnicode=true&useSSL=false&characterEncoding=utf8&serverTimezone=Asi
转载 10月前
36阅读
前言实际开发中,针对前后分离开发,需要编写许多业务接口,正规开发而言,还需要写对应的API文档;如果需求经常变更,API接口文档也需要时常变更,会相对很麻烦。如何既能满足需求的变更,又能对变更部分接口及时更新呢?可以使用Swagger实现。依赖引入<!-- swagger配置等注解 --> <dependency> <groupId>io.spr
转载 2024-08-06 22:29:32
54阅读
要了解非侵入方式能做到什么程度和技术思路, 最后 平衡下来多数情况下多数人还是会选择Swagger+openapi技术栈的。 准备知识点 需要了解Swagger侵入性和依赖性, 以及Smart-Doc这类工具如何解决这些问题, 部分内容来自 官方网站。 为什么会产生Smart-Doc这类工具? 既然有了Swagger, 为何还会产生Smart-Doc这类工具呢? 本
SpringBoot系列的文章已经更新十篇,每篇的阅读反响都还不错,果然大家还是对SpringBoot比较感兴趣。那今天我们就带来系列的第十一篇:集成Swagger接口文档以及Swagger的高级功能。 文章涉及到的代码已经上传到了github,希望最终能应用在你们实际项目上,当然如果有其他需要我添加到内容也可以直接留言告诉我,我会视情况给你们加上去的。SpringBoot 如何统一后端
转载 2023-11-30 22:24:28
56阅读
这里是实现自动化api稳当的生成,在网上看了很多swagger的文档,可能都是在为实现接口时直接使用的swagger,其实步骤差不多,但是更加详细的我还没看到,又或者说,我看着文档来的时候还是出错啦,绕了很大的弯,之前有听过要用这个,但是还是用过。接下来总结下我这次在使用过程中的步骤及一些问题。在接口已经成型的基础上集成swagger,实现了接口文档自动生成,相对于开发来说节约了写文档的大部分
转载 2024-06-22 19:08:56
302阅读
前言mybatis自带代码生成插件,我们来试试如何使用创建空项目我们通过IDEA的Spring Intializr先创建一个sbm-generator的项目目录结构标红部分是代码生成自动生成的代码,如何生成的请往下看添加依赖pom.xml引入代码生成依赖:<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://
转载 2024-09-14 23:43:59
112阅读
Springboot的出现极大的简化了开发人员的配置,而这之中的一大利器便是springboot的starter,starter是springboot的核心组成部分,springboot官方同时也为开发人员封装了各种各样方便好用的starter模块,例如:spring-boot-starter-web//spring MVC相关spring-boot-starter-aop //切面
我使用的环境配置 IDEA2019.2Spring Boot2.2.1.RELEASEGenerator1.3.7     POM 添加依赖:<plugin> <groupId>org.mybatis.generator</groupId>
转载 10月前
103阅读
Spring Boot集成 Swagger2 展现 — 在线接口文档 — 前后端分离专用接口文档1. Swagger 简介1.1 解决的问题随着互联网技术的发展,现在的网站架构基本都由原来的后端渲染,变成了前后端分离的形态,而且前端技术和后端技术在各自的道路上越走越远。前端和后端的唯一联系,变成了 API 接口,所以 API 文档变成了前后端开发人员联系的纽带,变得越来越重要。那么问题来了,随着代
转载 10月前
92阅读
  • 1
  • 2
  • 3
  • 4
  • 5