Swagger原理

最新推荐文章于 2023-08-17 14:37:33 发布
最新推荐文章于 2023-08-17 14:37:33 发布
阅读量1.2k 收藏 2
点赞数
分类专栏： Java 文章标签： Swagger
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/AE86JayChou/article/details/131056594
版权

最近在基于Swagger进行二次开发， 来对项目的接口进行管理，功能实现了，但是不清楚swagger的工作原理，为了后续能更好利用Swagger来管理接口，而且能借鉴Swagger的原理，将项目中其他信息可视化展示，决定Debug下Swagger的流程。版本使用的是springdoc-openapi，并不是旧版的swagger，但是口语上还是用swagger表示。

Swagger使用分两个阶段，第一个阶段是注册一些Bean，初始化一些配置。第二阶段是页面访问、接口调用，将数据填充到HTML页面展示在浏览器上。

注册静态资源

WebMvcConfigurationSupport类会实例化HandlerMapping这个Bean

在这里插入图片描述

实例化过程中，将所有的WebMvcConfigurer中定义的ResourceHandler放到ResourceHandlerRegistry中去。所有的WebMvcConfigurer包括系统默认的和自定义的，其中和Swagger相关的就是WebMvcAutoConfiguration类的内部类WebMvcAutoConfigurationAdapter中注册的ResourceHandler，处理的URL是/webjars/**，locations是classpath:/META-INF/resources/webjars/

在这里插入图片描述

另外一个和Swagger相关的是SwaggerWebMvcConfigurer，里面会处理/swagger-ui*/**路径，locations是classpath:/META-INF/resources/webjars/

在这里插入图片描述

在这里插入图片描述

ResourceHandlerRegistry注册完后，会调用ResourceHandlerRegistry的getHandlerMapping方法，实例化AbstractHandlerMapping。

在这里插入图片描述

在这里插入图片描述

对于Swagger静态资源，对应的是ResourceHttpRequestHandler。还需要注意到，最后生成AbstractHandlerMapping是SimpleUrlHandlerMapping，这在后面请求时会用到。

访问Swagger静态资源

首先访问Swagger首页地址，/swagger-ui/index.html，进入DispatcherServlet的doDispatch方法，根据Request对象获取mappedHandler

在这里插入图片描述

getHandler方法里面就是从不同的handlerMappings中获取HandlerExecutionChain，实际走的就是SimpleUrlHandlerMapping。

在这里插入图片描述

往SimpleUrlHandlerMapping的getHandler方法里看，最终是在SimpleUrlHandlerMapping父类AbstractUrlHandlerMapping的lookupHandler方法中，根据URL匹配出ResourceHttpRequestHandler，构造成HandlerExecutionChain对象返回。

在这里插入图片描述

再往下根据mappedHandler获取HandlerAdapter，实际获取到的就是HttpRequestHandlerAdapter

在这里插入图片描述

在这里插入图片描述

接着就会调用HttpRequestHandlerAdapter的handler方法，handler方法会将请求交给HttpRequestHandler的handleRequest方法，最终是交给ResourceHttpRequestHandler的handleRequest方法。在该方法中，首先就是获取Resource对象。

在这里插入图片描述

实际上是通过DefaultResourceResolverChain里面的WebJarsResourceResolver和PathResourceResolver得到最终的Resource对象，首先是将swagger-ui/index.html通过WebJarsResourceResolver转成swagger-ui/4.14.0/index.html，在将转化后的URL通过PathResourceResolver解析出Resource对象。

在这里插入图片描述

Swagger的静态资源是在org.webjars:swagger-ui:4.14.0中resources目录下

在这里插入图片描述

最后是将Resource对象的内容，写入HttpServletResponse中返回。

访问Swagger Rest接口

访问Swagger首页时，除了一些静态资源如html、css、js，Swagger还会访问/v3/api-docs/开头的后台Rest接口，这些接口会返回数据供页面使用，共同实现Swagger的功能。

在这里插入图片描述

像上图的swagger-config接口完整路径是/v3/api-docs/swagger-config，这个接口是在SwaggerConfigResource类中定义的。功能就是获取所有的group和对应的URL。

下面主要介绍另外一个接口，/v3/api-docs/{group}，这个接口是根据group名称获取该组下的所有接口。

接口定义是这样的

在这里插入图片描述

首先获取OpenApiResource对象，实际获取的是OpenApiWebMvcResource对象

在这里插入图片描述

接着调用openapiJson方法，最终调用的是AbstractOpenApiResource的getOpenApi方法

在这里插入图片描述

这个方法就是主要扫描接口的方法了，在openAPIService.build(finalLocale)那一句，就是扫描Controller的接口

在这里插入图片描述

当然还有其他处理，处理参数、返回值、执行一些自定义的customisers等等（后面有时间再每一步进去看下是Swagger是如何解析接口、请求数据、返回值的），最终返回一个OpenAPI对象，然后以Json格式的字符串返回给前端。

OpenAPI这个实体类的结构如下，从官网截取部分，以便理解，有了这个结构，可以自定义一些OpenApiCustomiser，对OpenAPI对象进行改动，进行二次开发，实现一些自定义功能。

openapi: 3.0.3
info:
  title: Swagger Petstore - OpenAPI 3.0
  description: |-
    This is a sample Pet Store Server based on the OpenAPI 3.0 specification.  You can find out more about
    Swagger at [https://swagger.io](https://swagger.io). In the third iteration of the pet store, we've switched to the design first approach!
    You can now help us improve the API whether it's by making changes to the definition itself or to the code.
    That way, with time, we can improve the API in general, and expose some of the new features in OAS3.
  termsOfService: http://swagger.io/terms/
  contact:
    email: apiteam@swagger.io
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  version: 1.0.11
externalDocs:
  description: Find out more about Swagger
  url: http://swagger.io
servers:
  - url: https://petstore3.swagger.io/api/v3
tags:
  - name: pet
    description: Everything about your Pets
    externalDocs:
      description: Find out more
      url: http://swagger.io
  - name: store
    description: Access to Petstore orders
    externalDocs:
      description: Find out more about our store
      url: http://swagger.io
paths:
  /pet:
    put:
      tags:
        - pet
      summary: Update an existing pet
      description: Update an existing pet by Id
      operationId: updatePet
      requestBody:
        description: Update an existent pet in the store
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Pet'
          application/xml:
            schema:
              $ref: '#/components/schemas/Pet'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Pet'
        required: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Pet'          
            application/xml:
              schema:
                $ref: '#/components/schemas/Pet'
        '400':
          description: Invalid ID supplied
        '404':
          description: Pet not found
        '405':
          description: Validation exception
      security:
        - petstore_auth:
            - write:pets
            - read:pets
    post:
      tags:
        - pet
      summary: Add a new pet to the store
      description: Add a new pet to the store
      operationId: addPet
      requestBody:
        description: Create a new pet in the store
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Pet'
          application/xml:
            schema:
              $ref: '#/components/schemas/Pet'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Pet'
        required: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Pet'          
            application/xml:
              schema:
                $ref: '#/components/schemas/Pet'
        '405':
          description: Invalid input
      security:
        - petstore_auth:
            - write:pets
            - read:pets

总结

流程还是比较清晰，Swagger提供一些Jar包，包含Rest接口和静态资源，应用启动时先注册静态资源、确定访问的URL，访问Swagger首页时，通过SpringMVC将Jar包中的静态资源取出，静态资源中请求后台Rest接口，由后台接口解析项目的Controller接口，返回接口信息给前端展示在页面上。

写这篇文章除了介绍Swagger原理，在Swagger基础上进行二次开发，另外一个目的就是是借鉴这种设计思路，和项目相关的信息可视化展示。比如项目脚本数据和数据表结构变更记录、Git文件提交记录等等。

AE86Jag
关注
  • 0
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
swagger-hack:自动化爬取并自动测试所有swagger-ui.html显示的接口
03-05
招摇 在测试中偶尔会碰到swagger附加的常见的对齐方式： 有的同轴接口特别多，每一个都手动去试根本试不过来随后用python写了个脚本自动爬取所有接口，配置好传参发包访问 原理是首先抓取获取到一些标准和对应的文档地址而后对每个标准下的接口文档进行解析，构造请求包，获取响应 尽量考虑到了所有可能的传参格式，实际测试只有少数几个会500或400响应需要手动修改一下，其余都是401或200 200就是未授权访问接口了，可以进一步做其他诸如sqli等测试运行时然后： 所有测试结果都存储在csv中： 欢迎大家关注稻草人安全团队，后续有更多技术文章，工具分享等
浅谈springfox-swagger原理解析与使用过程中遇到的坑
08-27
本篇文章主要介绍了浅谈springfox-swagger原理解析与使用过程中遇到的坑，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
配置swagger2 ,单controller层和多controller层配置 ,整合swagger-bootstrap-ui ,微服务集群搭建swagger
zhangshengqiang168的博客
03-22 2757
1.添加maven依赖 <!--Swagger-UI API文档生产工具--> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> ...
Swagger，好用的API管理神器（swagger学习简单总结）
Earl_yuan的专栏
06-04 7986
一、swagger简介1.1. swagger是什么？ THE WORLD’S MOST POPULAR API TOOLING Swagger is the world’s largest framework of API developer tools for the OpenAPI Specification(OAS), enabling development across the
swagger3+nginx访问swagger-config报404问题解决
Mr_Wanter
08-17 2398
http://localhost:8888/v3/api-docs/default时报404，本地访问正常。
springfox-swagger原理解析与使用过程中遇到的坑
热门推荐
w4hechuan2009的专栏
03-31 5万+
swagger简介        swagger确实是个好东西，可以跟据业务代码自动生成相关的api接口文档，尤其用于restful风格中的项目，开发人员几乎可以不用专门去维护rest api，这个框架可以自动为你的业务代码生成restfut风格的api，而且还提供相应的测试界面，自动显示json格式的响应。大大方便了后台开发人员与前端的沟通与联调成本。 springfox-swagger
swagger原理简介
weixin_33690367的博客
03-13 662
2019独角兽企业重金招聘Python工程师标准>>> ...
swagger 实现原理
Max的博客
10-29 1126
实现原理： 因为Swagger-ui读取的数据来源于/v2/api-docs，并且返回的是json数据。 所以只要自己写一个页面去解析json数据，并展现就可以实现自定义swagger的UI界面了 如何使用Swagger 1、引入jar包 首先需要在你的 pom.xml 中引入swagger的包 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagge...
swagger2.0使用及原理
豪猪的博客
04-05 2621
一、swagger2.0使用 引入依赖，构造Docket类用于展示，加注解 @EnableSwagger2 默认在线文档地址http://localhost:6050/swagger-ui.html swagger格式文件地址http://localhost:6050/v2/api-docs 二、swagger大致原理 2.1 将api解析存储到内存 1.通过@EnableSwagger2注解 ： a.扫描指定包下的类 b.import了其他配置类 c.注入bean 额外的：Spri...
Swagger2生成html文档
甘蓝的专栏
10-08 756
使用Swagger2生成html接口文档
SpringMVC使用的Swagger UI静态资源
12-28
Swagger 是一款RESTFUL接口的、基于YAML、JSON语言的文档在线自动生成、代码自动生成的工具。
swagger-ui静态资源
09-20
本资源基于swagger-ui官方15年发布的一套ui界面，包含 css样式、js、html、img等资源，亲自试用，这套资源完全可以构建swagger-ui
swaggerUI静态资源包
02-20
https://blog.csdn.net/weixin_42739423/article/details/87773763 spring整合swagger的ui文件
swagger-exp:Swagger API漏洞利用
03-25
Swagger API漏洞利用这是一个Swagger REST API信息可用的工具。主要功能有：遍历所有API接口，自动填充参数尝试GET / POST所有接口，返回响应代码/ Content-Type / Content-Length，用于分析接口是否可以未授权访问...
Swagger API漏洞利用-JavaScript开发
05-26
Swagger API Exploit 这是一个 Swagger REST API 信息泄露利用工具。 主要功能有： 遍历所有API接口，自动填充参数 尝试 GET / POST 所有接口，返回 Response Code / Content-Type / Content-Length ，用于分析接 ...
ng-swagger-gen：Angular的Swagger 2.0代码
01-31
生成的类遵循的原理。 注意：该项目已不再积极维护。 自2019年以来，我们的开发重点已移至 ，而维护这两个项目的Cyclos项目早已移至OpenAPI3。因此，对ng-swagger-gen的维护基本上是由社区通过拉取请求。 但是，...
ROS基于C++动力学约束的路径规划源码+ppt文件.zip
04-30
ROS基于C++动力学约束的路径规划源码+ppt文件.zip
ASP.NET BS结构的城市酒店入住信息管理系统的设计
04-30
ASP.NET B/S结构城市酒店入住信息管理系统的设计与实现简介 一、项目背景与意义 随着城市旅游的蓬勃发展，酒店业作为旅游产业链中的重要一环，面临着日益激烈的市场竞争。为了提升酒店的服务质量和管理效率，信息化管理成为酒店业不可或缺的一部分。因此，我们设计并实现了一个基于ASP.NET的B/S（浏览器/服务器）结构城市酒店入住信息管理系统。该系统旨在帮助酒店实现入住信息的快速录入、查询、修改和统计，提升酒店的运营效率和客户体验。 二、系统主要功能 用户管理：系统支持管理员、前台服务员、客户等不同角色的注册、登录和权限管理。通过角色权限的设置，确保系统数据的安全性和完整性。 房间管理：管理员可以添加、编辑、删除房间信息，包括房间类型、价格、状态等。前台服务员可以实时查看房间状态，为客人办理入住和退房手续。 入住信息管理：前台服务员可以录入客人的入住信息，包括姓名、证件号码、联系方式、入住时间和离店时间等。系统支持客人信息的快速查询和修改，方便前台服务员处理各种客户需求。 费用管理：系统根据客人的入住时间和房间价格自动计算费用，并支持多种支付方式。管理员可以设置折扣、优惠券等促销
基于streamlit的YOLOv8可视化交互界面
最新发布
04-30
基于streamlit的YOLOv8可视化交互界面
springboot swagger oauth2 token鉴权实现代码及原理
06-13
Spring Boot是一个快速开发框架，Swagger是一个API文档生成工具，OAuth2是一个授权框架，可以用于保护API。 下面是Spring Boot集成Swagger和OAuth2的代码实现和原理解释： 1. 添加Swagger依赖 在pom.xml中添加Swagger依赖： ```xml <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.9.2</version> </dependency> ``` 2. 添加Swagger配置 在Spring Boot的配置类中添加Swagger配置： ```java @Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2) .select() .apis(RequestHandlerSelectors.any()) .paths(PathSelectors.any()) .build(); } } ``` 3. 添加OAuth2依赖 在pom.xml中添加OAuth2依赖： ```xml <dependency> <groupId>org.springframework.security.oauth.boot</groupId> <artifactId>spring-security-oauth2-autoconfigure</artifactId> <version>2.1.4.RELEASE</version> </dependency> ``` 4. 添加OAuth2配置 在Spring Boot的配置类中添加OAuth2配置： ```java @Configuration @EnableResourceServer public class ResourceServerConfig extends ResourceServerConfigurerAdapter { @Override public void configure(HttpSecurity http) throws Exception { http.authorizeRequests().anyRequest().authenticated(); } } ``` 5. 添加Token鉴权 添加Token鉴权的方式是在控制器方法上添加@PreAuthorize注解，指定需要的角色或权限： ```java @RestController @RequestMapping("/api") public class ApiController { @GetMapping("/hello") @PreAuthorize("hasRole('ADMIN')") public String hello() { return "Hello World!"; } } ``` 6. 请求Token 使用OAuth2的客户端工具请求Token： ```java public class OAuth2Client { public static void main(String[] args) { Base64.Encoder encoder = Base64.getEncoder(); String clientCredentials = "client_id:client_secret"; String encodedClientCredentials = encoder.encodeToString(clientCredentials.getBytes()); String url = "http://localhost:8080/oauth/token"; HttpHeaders headers = new HttpHeaders(); headers.setAccept(Arrays.asList(MediaType.APPLICATION_JSON)); headers.add("Authorization", "Basic " + encodedClientCredentials); MultiValueMap<String, String> map = new LinkedMultiValueMap<>(); map.add("grant_type", "client_credentials"); HttpEntity<MultiValueMap<String, String>> request = new HttpEntity<>(map, headers); RestTemplate restTemplate = new RestTemplate(); ResponseEntity<String> response = restTemplate.postForEntity(url, request, String.class); System.out.println(response.getBody()); } } ``` 以上就是Spring Boot集成Swagger和OAuth2的代码实现和原理解释。其中Swagger用于生成API文档，OAuth2用于保护API，Token鉴权用于限制访问API的角色或权限。

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

打赏作者

AE86Jag

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

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

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

打赏作者

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

抵扣说明：

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

余额充值