syy/SYYTe
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

优化Swagger配置，按分组显示接口文档

This commit is contained in:
阿沐 2024-07-30 10:51:47 +08:00
parent ea8d19b1da
commit 6d675c8982
2 changed files with 103 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
maku-framework/src/main/java/net/maku/framework/common/config/SwaggerConfig.java
View File

@ -1,43 +0,0 @@
package net.maku.framework.common.config;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Contact;
import io.swagger.v3.oas.models.info.Info;
import io.swagger.v3.oas.models.info.License;
import org.springdoc.core.models.GroupedOpenApi;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
/**
* Swagger配置
*
* @author 阿沐 babamu@126.com
*/
@Configuration
public class SwaggerConfig {
@Bean
public GroupedOpenApi userApi() {
String[] paths = {"/**"};
String[] packagedToMatch = {"net.maku"};
return GroupedOpenApi.builder().group("MakuBoot")
.pathsToMatch(paths)
.packagesToScan(packagedToMatch).build();
}
@Bean
public OpenAPI customOpenAPI() {
Contact contact = new Contact();
contact.setName("阿沐 babamu@126.com");
return new OpenAPI().info(new Info()
.title("MakuBoot")
.description("MakuBoot")
.contact(contact)
.version("3.0")
.termsOfService("https://maku.net")
.license(new License().name("MIT")
.url("https://maku.net")));
}
}

103
maku-server/src/main/java/net/maku/SwaggerConfig.java Normal file
View File

@ -0,0 +1,103 @@
package net.maku;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Contact;
import io.swagger.v3.oas.models.info.Info;
import org.springdoc.core.models.GroupedOpenApi;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
/**
* Swagger配置
*
* @author 阿沐 babamu@126.com
*/
@Configuration
public class SwaggerConfig {
@Bean
public GroupedOpenApi systemApi() {
String[] paths = {"/**"};
String[] packagedToMatch = {"net.maku.system"};
return GroupedOpenApi.builder()
.group("1")
.displayName("System API")
.pathsToMatch(paths)
.packagesToScan(packagedToMatch).build();
}
@Bean
public GroupedOpenApi quartzApi() {
String[] paths = {"/**"};
String[] packagedToMatch = {"net.maku.quartz"};
return GroupedOpenApi.builder()
.group("2")
.displayName("Quartz API")
.pathsToMatch(paths)
.packagesToScan(packagedToMatch).build();
}
@Bean
public GroupedOpenApi monitorApi() {
String[] paths = {"/**"};
String[] packagedToMatch = {"net.maku.monitor"};
return GroupedOpenApi.builder()
.group("3")
.displayName("Monitor API")
.pathsToMatch(paths)
.packagesToScan(packagedToMatch).build();
}
@Bean
public GroupedOpenApi memberApi() {
String[] paths = {"/**"};
String[] packagedToMatch = {"net.maku.member"};
return GroupedOpenApi.builder()
.group("4")
.displayName("Member API")
.pathsToMatch(paths)
.packagesToScan(packagedToMatch).build();
}
@Bean
public GroupedOpenApi iotApi() {
String[] paths = {"/**"};
String[] packagedToMatch = {"net.maku.iot"};
return GroupedOpenApi.builder()
.group("5")
.displayName("Iot API")
.pathsToMatch(paths)
.packagesToScan(packagedToMatch).build();
}
@Bean
public GroupedOpenApi otherApi() {
String[] paths = {"/**"};
String[] packagedToMatch = {"net.maku"};
return GroupedOpenApi.builder()
.group("99")
.displayName("Other API")
.pathsToMatch(paths)
.packagesToExclude(
"net.maku.system", "net.maku.quartz", "net.maku.monitor", "net.maku.member", "net.maku.iot",
"net.maku.generator"
)
.packagesToScan(packagedToMatch)
.build();
}
@Bean
public OpenAPI openApi() {
Contact contact = new Contact();
contact.setName("阿沐 babamu@126.com");
return new OpenAPI().info(new Info()
.title("Maku API")
.description("Maku API")
.contact(contact)
.version("3.x")
.termsOfService("https://maku.net")
);
}
}