feat: Improve Swagger/OpenAPI documentation.

Author: ReLive27

extensions/openapi/build.gradle

@@ -0,0 +1,9 @@
+jar {
+    archiveBaseName = 'simpleauth0-openapi'
+    archiveVersion = version
+    archiveExtension = 'jar'
+}
+
+dependencies {
+    api libraries.springdocOpenAPI
+}

extensions/openapi/src/main/java/io/github/simpleauth0/openapi/OpenApiConfiguration.java

@@ -0,0 +1,45 @@
+package io.github.simpleauth0.openapi;
+
+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.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+/**
+ * @author: ReLive27
+ * @date: 2025/7/27 22:42
+ */
+@Configuration
+public class OpenApiConfiguration {
+
+    @Bean
+    public OpenAPI customOpenAPI() {
+        return new OpenAPI()
+                .info(new Info()
+                        .title("SimpleAuth0 身份与访问管理 API 文档")
+                        .version("v1")
+                        .description(
+                                "**SimpleAuth0** 是一个开源的身份与访问管理（IAM）平台，" +
+                                        "致力于为开发者提供安全、灵活、易集成的认证与授权解决方案。\n\n" +
+                                        "主要功能包括：\n" +
+                                        "- 支持多种身份认证协议（OAuth 2.0、OIDC、SAML、LDAP 等）\n" +
+                                        "- 提供统一的用户认证与单点登录（SSO）\n" +
+                                        "- 支持多因素认证（MFA）与细粒度访问控制\n" +
+                                        "- 丰富的审计与安全日志功能\n\n" +
+                                        "本文档提供 SimpleAuth0 服务端的 RESTful API 接口说明，" +
+                                        "便于开发者集成、定制与二次开发。"
+                        )
+                        .contact(new Contact()
+                                .name("SimpleAuth0 开发团队")
+                                .url("https://github.com/SimpleAuth0")
+                                .email("support@simpleauth0.io"))
+                        .license(new License()
+                                .name("MIT License")
+                                .url("https://opensource.org/licenses/MIT"))
+                );
+    }
+
+
+}

extensions/openapi/src/main/resources/META-INF/spring.factories

@@ -0,0 +1,2 @@
+org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
+io.github.simpleauth0.openapi.OpenApiConfiguration

server/build.gradle

@@ -8,5 +8,6 @@ dependencies {
     implementation project(':simpleauth0-core')
     implementation project(':simpleauth0-security')
     implementation project(':simpleauth0-repository')
+    implementation project(':simpleauth0-openapi')
     implementation libraries.springBootStarterWeb
 }

server/src/main/resources/application.yml

@@ -4,3 +4,11 @@ simpleauth0:
   token:
     opaque:
       format: base64
+
+springdoc:
+  api-docs:
+    path: /v3/api-docs
+    enabled: ${OPENAPI_ENABLE:true}
+  swagger-ui:
+    path: /swagger-ui/index.html
+    enabled: ${OPENAPI_ENABLE:true}

settings.gradle

@@ -23,10 +23,6 @@ include (':server')
 project(':server').projectDir = file('server')
 project(':server').name = 'simpleauth0-server'
 
-include (':extensions')
-project(':extensions').projectDir = file('extensions')
-project(':extensions').name = 'simpleauth0-extensions'
-
 include (':audit')
 project(':audit').projectDir = file('audit')
 project(':audit').name = 'simpleauth0-audit'
@@ -46,3 +42,8 @@ project(':repository').name = 'simpleauth0-repository'
 include(':security')
 project(':security').projectDir = file('security')
 project(':security').name = 'simpleauth0-security'
+
+include(':openapi')
+project(':openapi').projectDir = file('extensions/openapi')
+project(':openapi').name = 'simpleauth0-openapi'
+