Browse Source

修复swagger配置

master
xsx 6 months ago
parent
commit
6c4df16f0b
  1. 6
      im-admin/pom.xml
  2. 30
      im-admin/ruoyi-admin/src/main/resources/application.yml
  3. 5
      im-admin/ruoyi-common/ruoyi-common-doc/pom.xml

6
im-admin/pom.xml

@ -117,6 +117,12 @@
<version>${springdoc.version}</version> <version>${springdoc.version}</version>
</dependency> </dependency>
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
<version>${springdoc.version}</version>
</dependency>
<dependency> <dependency>
<groupId>com.github.therapi</groupId> <groupId>com.github.therapi</groupId>
<artifactId>therapi-runtime-javadoc</artifactId> <artifactId>therapi-runtime-javadoc</artifactId>

30
im-admin/ruoyi-admin/src/main/resources/application.yml

@ -113,7 +113,10 @@ security:
# swagger 文档配置 # swagger 文档配置
- /*/api-docs - /*/api-docs
- /*/api-docs/** - /*/api-docs/**
- /swagger-ui/**
- /swagger-ui.html
- /v3/api-docs
- /v3/api-docs/**
# MyBatisPlus配置 # MyBatisPlus配置
# https://baomidou.com/config/ # https://baomidou.com/config/
@ -144,16 +147,29 @@ mybatis-encryptor:
publicKey: publicKey:
privateKey: privateKey:
# 【bug】ruoyi的这个文档配置似乎没有生效,跟代码也对不上 # SpringDoc OpenAPI 3.0 配置,访问: http://localhost:8889/swagger-ui/index.html
springdoc: springdoc:
api-docs: api-docs:
# 是否开启接口文档 # 是否开启接口文档
enabled: true enabled: true
# API文档路径
path: /v3/api-docs
swagger-ui:
# Swagger UI 访问路径
path: /swagger-ui.html
# 是否启用
enabled: true
# 显示操作ID
display-operation-id: true
# 显示请求持续时间
display-request-duration: true
info: info:
# 标题 # 标题
title: '标题:${app.name}后台管理系统' title: '${app.name}后台管理系统'
# 版本 # 版本
version: '版本号: ${app.version}' version: '${app.version}'
# 描述
description: '盒子IM后台管理系统API文档'
components: components:
# 鉴权方式配置 # 鉴权方式配置
security-schemes: security-schemes:
@ -161,10 +177,10 @@ springdoc:
type: APIKEY type: APIKEY
in: HEADER in: HEADER
name: ${sa-token.token-name} name: ${sa-token.token-name}
#这里定义了两个分组,可定义多个,也可以不定义 # 分组配置
group-configs: group-configs:
- group: 1.演示模块 - group: 1.IM模块
packages-to-scan: org.dromara.demo packages-to-scan: org.dromara.im
- group: 2.通用模块 - group: 2.通用模块
packages-to-scan: org.dromara.web packages-to-scan: org.dromara.web
- group: 3.系统模块 - group: 3.系统模块

5
im-admin/ruoyi-common/ruoyi-common-doc/pom.xml

@ -26,6 +26,11 @@
<artifactId>springdoc-openapi-starter-webmvc-api</artifactId> <artifactId>springdoc-openapi-starter-webmvc-api</artifactId>
</dependency> </dependency>
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
</dependency>
<dependency> <dependency>
<groupId>com.github.therapi</groupId> <groupId>com.github.therapi</groupId>
<artifactId>therapi-runtime-javadoc</artifactId> <artifactId>therapi-runtime-javadoc</artifactId>

Loading…
Cancel
Save