7. 实现 API 自动生成

最新推荐文章于 2024-05-20 18:08:43 发布
最新推荐文章于 2024-05-20 18:08:43 发布
阅读量1.3k 收藏 1
点赞数
分类专栏： 项目 文章标签： java 开发语言
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_58969626/article/details/132308153
版权
Swagger 简介：Swagger 是⼀套 API 定义的规范 ，按照这套规范的要求去定义接口及接口相关信息， 再通过可以解析这套规范工具，就可以生成各种格式的接口文档，以及在线接口调试页面，通过自动文档的方式，解决了接口文档更新不及时的问题。
Springfox 简介：是对 Swagger 规范解析并生成文档的⼀个实现。

1. pom.xml中引用依赖

统⼀管理版本，在 properties 标签中加入版本号：

<springfox-boot-starter.version>3.0.0</springfox-boot-starter.version>

3.0.0 版本对应 Spring Boot 2.6 之前的版本，但是随着 Spring Boot 的更新 Springfox 并没有进行同步的更新，所以存在一些兼容性问题，因此我们选择使用 SpringBoot 2.7.6 版本。

2. 引入相关的依赖

<!-- API⽂档⽣成，基于swagger2 -->
<dependency>
 <groupId>io.springfox</groupId>
 <artifactId>springfox-boot-starter</artifactId>
 <version>${springfox-boot-starter.version}</version>
</dependency>
<!-- SpringBoot健康监控 -->
<dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>

3. 编写配置类

  • 在com.bitejiuyeke.forum.config 包下新建SwaggerConfig.java
  • 解决 SpringBoot 2.6.0 以上与 Springfox3.0.0 不兼容的问题，涉及 SpringBoot 版本升级过程中的一 些内部实现变化，具体说明在修改配置文件部分

 将以下代码复制到 SwaggerConfig 类中：

package com.example.demo.controller;

import org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties;
import org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties;
import org.springframework.boot.actuate.autoconfigure.web.server.ManagementPortType;
import org.springframework.boot.actuate.endpoint.ExposableEndpoint;
import org.springframework.boot.actuate.endpoint.web.*;
import org.springframework.boot.actuate.endpoint.web.annotation.ControllerEndpointsSupplier;
import org.springframework.boot.actuate.endpoint.web.annotation.ServletEndpointsSupplier;
import org.springframework.boot.actuate.endpoint.web.servlet.WebMvcEndpointHandlerMapping;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.Environment;
import org.springframework.util.StringUtils;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.oas.annotations.EnableOpenApi;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
/**
 * Swagger配置类
 */
// 配置类
@Configuration
// 开启Springfox-Swagger
@EnableOpenApi
public class SwaggerConfig {
    /**
     * Springfox-Swagger基本配置
     * @return
     */
    @Bean
    public Docket createApi() {
        Docket docket = new Docket(DocumentationType.OAS_30)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller"))
                .paths(PathSelectors.any())
                .build();
        return docket;
    }
    // 配置API基本信息
    private ApiInfo apiInfo() {
        ApiInfo apiInfo = new ApiInfoBuilder()
                .title("论坛系统API")
                .description("论坛系统前后端分离API测试")
                .contact(new Contact("Test",
                        "https://hello.fprum.com", "1111111111@qq.com"))
                .version("1.0")
                .build();
        return apiInfo;
    }
    /**
     * 解决SpringBoot 6.0以上与Swagger 3.0.0 不兼容的问题
     * 复制即可
     **/
    @Bean
    public WebMvcEndpointHandlerMapping
    webEndpointServletHandlerMapping(WebEndpointsSupplier webEndpointsSupplier,

                                     ServletEndpointsSupplier servletEndpointsSupplier,

                                     ControllerEndpointsSupplier controllerEndpointsSupplier,

                                     EndpointMediaTypes endpointMediaTypes, CorsEndpointProperties corsProperties,

                                     WebEndpointProperties webEndpointProperties, Environment environment) {
        List<ExposableEndpoint<?>> allEndpoints = new ArrayList();
        Collection<ExposableWebEndpoint> webEndpoints =
                webEndpointsSupplier.getEndpoints();
        allEndpoints.addAll(webEndpoints);
        allEndpoints.addAll(servletEndpointsSupplier.getEndpoints());
        allEndpoints.addAll(controllerEndpointsSupplier.getEndpoints());
        String basePath = webEndpointProperties.getBasePath();
        EndpointMapping endpointMapping = new EndpointMapping(basePath);
        boolean shouldRegisterLinksMapping =
                this.shouldRegisterLinksMapping(webEndpointProperties, environment,
                        basePath);
        return new WebMvcEndpointHandlerMapping(endpointMapping, webEndpoints,
                endpointMediaTypes,
                corsProperties.toCorsConfiguration(), new
                EndpointLinksResolver(allEndpoints, basePath),
                shouldRegisterLinksMapping, null);
    }
    private boolean shouldRegisterLinksMapping(WebEndpointProperties
                                                       webEndpointProperties, Environment environment,
                                               String basePath) {
        return webEndpointProperties.getDiscovery().isEnabled() &&
                (StringUtils.hasText(basePath)
                        ||
                        ManagementPortType.get(environment).equals(ManagementPortType.DIFFERENT));
    }
}

4. application.yml 中添加配置

  • 在 spring 节点下添加 mvc 配置项
由于 SpringBoot 2.6 之后版本把 SpringMVC 路径匹配策略修改为 MatchingStrategy. PATH_PATTERN_PARSER;
而 Springfox-Swagger 还没有更新版本，我们暂时先把 路径匹配策略回退到之前的
MatchingStrategy. ANT_PATH_MATCHER 
 mvc:
   path match:
    matching-strategy: ANT_PATH_MATCHER #Springfox-Swagger兼容性配置

5. API 常用注解 

  •  @Api: 作用在 Controller 上，对控制器类的说明
    • tags="说明该类的作用，可以在前台界面上看到的注解"
  •  @ApiModel: 作用在响应的类上，对返回响应数据的说明
  •  @ApiModelProerty:作用在类的属性上，对属性的说明
  •  @ApiOperation: 作用在具体方法上，对 API 接口的说明
  •  @ApiParam: 作用在方法中的每⼀个参数上，对参数的属性进行说明

6. 访问 API 列表

启动程序，在浏览器中输入网址：http://127.0.0.1:58080/swagger-ui/index.html

可以正常运行并显示接口信息，说明配置成功，此时接口信息已经显示出来了，可以分别针每个接口进测试，具操作按页面指引即可。

点击“测试接口”出现如下图所示： 

选择对应的 API 列表，点击“Try it out”： 

点击 Execute： 

图中箭头所指方向即为测试结果。

带有参数的同样可以进行测试：

7. API 导入 Postman

获取 API 地址，打开 Swagger 页面的 API 资源地址并复制：

 在 Postman 中导入 url：

接下来输入参数：

 

小鱼的学习笔记
关注
  • 0
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
HTML5拖放API实现自动生成相框功能
11-21
实现功能： 将桌面图片拖入指定地方，生成相框和相关信息。 相框需要自己配置，设置为背景，在CSS中设置。 效果如图： html部分： <!DOCTYPE html> <html> <head> <meta charset="UTF-8"> <title></title> <link rel="stylesheet" type="text/css" href="test3.css"/> [removed][removed] </head> <body> <h1 style="text-ali
open api文档自动生成工具
02-06
自己开发的，可以通过在线编辑JSON数据自动生成HTML API说明文档，分享一下！
Java 对外API接口开发 java开发api接口如何编写
最新发布
2301_78159247的博客
05-20 1055
Collection：单列集合类的根接口，用于存储一系列符合某种规则的元素，它有两个重要的子接口，分别是List和Set。Map：双列集合类的根接口，用于存储具有键（Key）、值（Value）映射关系的元素，每个元素都包含一对键值，其中键值不可重复且每个键最多只能映射到一个值，在使用Map集合时可以通过指定的Key找到对应的Value。某些场合下可能需要把基本数据类型的数据作为对象来使用，为了解决这样的问题，JDK中提供了一系列的包装类，可以把基本数据类型的值包装为引用数据类型的对象。
java SpringBoot（二十）SpringBoot Swagger自动生成API接口文档
qq_40771567的博客
06-10 351
什么是Swagger： Swagger是一款Restful接口的文档在线自动生成和功能测试功能软件。 Swagger是一个规范和完整的框架，用于生成、描述、调用和可视化Restful风格的Web服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。 pom中导入依赖： <!--Swagger-UI API文档生产工具--> <dependency> <groupId&gt.
Java api文档自动生成工具smartdoc+torna
北巷东东的专栏
08-31 2836
首先，一般做java服务端都用过postman，并且都写过前端调用的api文档接口，并且也用过市面上的一些工具。 API自文档动生成，能够省去了写文档的时间。 当然，当前也会有很多类似的开源工具，我们先看几种对比下。 api 文档写作对比 为什么写这几个，因为涉及到API文档的演变 1、传统的word文档 内部使用，使用word固定格式，写麻烦，共享更麻烦 2、showdoc 增加了api文档的统一格式，写变简单的，共享变简单了 3、swagger 增加了java代码注释，自动生成API文档，基本上不用怎么
Javapoet API（Java代码自动生成）简介及使用思路
weixin_34405925的博客
09-23 401
目录 基础总结 JavaPoet简介 使用总结 最小案例 类说明 公共 方法相关 其他 JavaPoet 官网 基础总结 JavaPoet简介 JavaPoet 是一个生成.Java源文件的Java API。源文件生成在annotation processing 或者和一些元数据，例如文件，数据库设计，协议格式等，进行交互时会很有用。通过代码生成，你能够减少冗余的代码模板，同时保证...
解放双手！无需注解快速生成API文档，跟SpringBoot绝配！
Java知音
08-11 363
做技术管理的童鞋，往往会陷入这样一种困境：疲于奔命，到处救火填坑，沟通推进，却挤不出时间思考对团队和项目来说真正重要的事情。你有没有经历过这样的场景：下属老是改了接口但不维护文档，屡说不改后端改了接口没有及时通知前端和测试，导致下游环节的同事来投诉由于团队每个角色使用的工具不同，工具之间的数据又无法兼容互通，导致一些共用的数据，每个人却要自己重复去创建、复制一遍；而一旦出...
Django 自动生成api接口文档教程
09-18
这样，你就可以在浏览器中访问`/api/docs/`来查看自动生成的API文档了。通常，djangorestframework会自动处理模型、序列化器、视图等，为你生成详细的API接口描述。 然而，这只是一个简单的示例，实际的API可能会...
python 利用toapi库自动生成api
01-19
在学习做接口测试自动化的时候，我们往往会自己动手写一些简单的API，比如写一个简单的TODO API之类。 不过自己写API的时候经常需要造一些假数据，以及处理分页逻辑，开始的时候还觉得比较有意思，但久而久之就显得...
使用 Postman 实现 API 自动化测试.doc
07-09
使用 Postman 实现 API 自动化测试 Postman 是一个功能强大且流行的 API 测试工具，开发人员和测试人员对其非常熟悉。然而，Postman 本身是一个图形化软件，对于实现自动化测试相对较难或较麻烦。幸运的是，Postman...
IDEA手动或自动生成API
w2765076540的博客
12-16 1246
本文详细介绍了API文档的生成步骤，希望能够帮助到网友们
EasyYapi插件—快速生成API接口文档
Java笔记
05-16 1912
Preferences → Plugins → Marketplace → 搜索“EasyYapi” → 安装该插件 → 重启IDE。使用下面的方式获取token信息，并配置在idea中。EasyYapi插件—快速生成API接口文档。2.2.1 postman请求。生成postman的token。2.2.2 Yapi请求。2.2 idea配置。
JAVA入坑之JAVADOC（Java API 文档生成器）与快速生成
qq_62377885的博客
04-30 3913
Javadoc是Java SE中的一个工具，文档注释以/**开头，并以*/结束，可以通过 Javadoc 生成一个和源代码配套的 API 帮助文档，Java 帮助文档主要用来说明类、成员变量和方法的功能。文档注释只放在类、接口、成员变量、方法之前，因为 Javadoc 只处理这些地方的文档注释，而忽略其它地方的文档注释。
Spring Boot + Swagger2 自动生成api接口文档
zhangjiaming_zjm的博客
11-21 1678
Spring Boot + Swagger2 自动生成api接口文档
SpringBoot 优雅整合Swagger Api 自动生成文档
Javaesandyou的博客
11-30 171
一个好的可持续交付的项目，项目说明，和接口文档是必不可少的，swagger api 就可以帮我们很容易自动生成api 文档，不需要单独额外的去写，无侵入式，方便快捷大大减少前后端的沟通方便查找和测试接口提高团队的开发效率方便新人了解项目，剩余的时间就可以去约妹子啦 整合swagger api# 这里我们自己去整合swagger api比较麻烦，要导入好几个包，有大神帮我们写好了轮子kinfe4j直接对应SpringBoot的启动项，而且在不影响原来使用功能上界面ui做了美化功能做了增强 我们直接整合这个
java添加api_创建Java API请求
weixin_39801202的博客
02-16 675
以下内容是马老师培训的，也自己玩了一下，弄了一下午啊，中间都要放弃了，多点了个workplace，导致怎样都跑不通，最后，终于跑通了。创建Java API请求目的：以百度天气预报查询API服务为例，创建Java API请求范例。API服务信息接口示例：http://api.map.baidu.com/telematics/v3/weather?location=北京&output=json...
java生成api文档工具_api文档自动生成工具
weixin_35411561的博客
02-13 1201
别问我比swagger好在哪里，无代码入侵，无注释，无注解都能生成文档这里只是我写文档的一个笔记工具，我发现被google收录了，好多人通过这个看到我分享的代码，反而github无人问津，悲哀以下是文章原文api-docjava开发，根据代码自动生成api接口文档工具，支持RESTful风格预览基本信息演示数据模拟mock在线预览地址开发原理这个工具是一个典型的前后端分离开发的项目，想了解前后端分...
java生成API文档
天天乐见的笔记本
05-27 4012
最近想要对java项目自动生成API文档，发现一个工具apidoc。这个工具可以依据一定格式的注释生成相应的HTML格式API接口文档，具体可以参考apidoc的官网。 使用方法如下： 安装命令 npm install apidoc -g 生成文档命令 apidoc -i myapp/ -o apidoc/ myapp是项目的文件夹，需要包含apidoc.json，以及含有接口注释的...
html5自动生成图片,HTML5拖放API如何实现自动生成相框功能 HTML5拖放API实现自动生成相框功能代码...
05-26
实现自动生成相框功能可以结合HTML5的Canvas和拖放API来完成。具体实现步骤如下： 1. HTML布局 首先，我们需要在HTML中定义一个Canvas元素和一个可以拖放的图片元素。 ```html <canvas id="canvas"></canvas> <img id="image" src="path/to/image.jpg" draggable="true"> ``` 2. JS处理拖放事件 接下来，我们需要通过JS来处理图片元素的拖放事件，并将拖放的图片渲染到Canvas上。 ```javascript var canvas = document.getElementById("canvas"); var context = canvas.getContext("2d"); var image = document.getElementById("image"); image.addEventListener("dragstart", function(event) { // 阻止默认拖放行为 event.preventDefault(); }); canvas.addEventListener("dragover", function(event) { // 阻止默认拖放行为 event.preventDefault(); }); canvas.addEventListener("drop", function(event) { // 阻止默认拖放行为 event.preventDefault(); // 获取拖放的图片 var file = event.dataTransfer.files[0]; // 创建一个图片对象并设置src属性 var image = new Image(); image.src = URL.createObjectURL(file); // 图片加载完成后，绘制到Canvas上 image.onload = function() { context.drawImage(image, 0, 0); }; }); ``` 3. 实现生成相框功能 最后，我们需要实现生成相框功能。这里简单起见，我们直接在Canvas上绘制一个相框。 ```javascript // 绘制相框 context.beginPath(); context.lineWidth = "10"; context.strokeStyle = "white"; context.rect(0, 0, canvas.width, canvas.height); context.stroke(); ``` 完整代码如下： ```html <canvas id="canvas"></canvas> <img id="image" src="path/to/image.jpg" draggable="true"> <script> var canvas = document.getElementById("canvas"); var context = canvas.getContext("2d"); var image = document.getElementById("image"); image.addEventListener("dragstart", function(event) { // 阻止默认拖放行为 event.preventDefault(); }); canvas.addEventListener("dragover", function(event) { // 阻止默认拖放行为 event.preventDefault(); }); canvas.addEventListener("drop", function(event) { // 阻止默认拖放行为 event.preventDefault(); // 获取拖放的图片 var file = event.dataTransfer.files[0]; // 创建一个图片对象并设置src属性 var image = new Image(); image.src = URL.createObjectURL(file); // 图片加载完成后，绘制到Canvas上 image.onload = function() { context.drawImage(image, 0, 0); // 绘制相框 context.beginPath(); context.lineWidth = "10"; context.strokeStyle = "white"; context.rect(0, 0, canvas.width, canvas.height); context.stroke(); }; }); </script> ```

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值