76602715b1
- Introduce ServerURL field in YaoMetadata to provide the public server URL for the instance, with a fallback mechanism. - Implement resolveServerURL function to determine the ServerURL based on the YAO_SERVER_URL environment variable or the issuer_url. - Update yaoMetadata method to populate the ServerURL field, enhancing API endpoint construction for clients and integrations.
107 lines
3.6 KiB
Go
107 lines
3.6 KiB
Go
package openapi
|
|
|
|
import (
|
|
"os"
|
|
"strings"
|
|
|
|
"github.com/gin-gonic/gin"
|
|
"github.com/yaoapp/yao/share"
|
|
)
|
|
|
|
// attachWellKnown attaches the well-known handlers to the router
|
|
func (openapi *OpenAPI) attachWellKnown(router *gin.Engine) {
|
|
|
|
// OAuth Discovery and Metadata Endpoints
|
|
wellKnown := router.Group("/.well-known")
|
|
|
|
// Yao Configuration Metadata - for client discovery
|
|
wellKnown.GET("/yao", openapi.yaoMetadata)
|
|
|
|
// OAuth Authorization Server Metadata - RFC 8414 (Required by MCP)
|
|
wellKnown.GET("/oauth-authorization-server", openapi.oauthServerMetadata)
|
|
|
|
// OpenID Connect Discovery - OpenID Connect Discovery 1.0
|
|
wellKnown.GET("/openid_configuration", openapi.oauthOpenIDConfiguration)
|
|
|
|
// OAuth Protected Resource Metadata - RFC 9728 (Required by MCP)
|
|
wellKnown.GET("/oauth-protected-resource", openapi.oauthProtectedResourceMetadata)
|
|
}
|
|
|
|
// YaoMetadata represents the Yao server configuration metadata
|
|
type YaoMetadata struct {
|
|
// Application information
|
|
Name string `json:"name,omitempty"`
|
|
Version string `json:"version,omitempty"`
|
|
Description string `json:"description,omitempty"`
|
|
|
|
// OpenAPI configuration
|
|
OpenAPI string `json:"openapi"` // OpenAPI base URL (e.g., "/v1")
|
|
IssuerURL string `json:"issuer_url,omitempty"` // OAuth issuer URL
|
|
|
|
// Public server URL — the externally accessible base URL for this instance.
|
|
// Clients, proxies, and integrations should use this to construct API endpoints.
|
|
// Set via env YAO_SERVER_URL; falls back to issuer_url (stripped of path), then empty.
|
|
ServerURL string `json:"server_url,omitempty"`
|
|
|
|
// Dashboard configuration
|
|
Dashboard string `json:"dashboard,omitempty"` // Admin dashboard root path
|
|
Optional map[string]interface{} `json:"optional,omitempty"` // Optional settings
|
|
|
|
// Developer information
|
|
Developer *share.Developer `json:"developer,omitempty"`
|
|
}
|
|
|
|
// yaoMetadata returns Yao server configuration metadata
|
|
func (openapi *OpenAPI) yaoMetadata(c *gin.Context) {
|
|
// Get admin root path
|
|
dashboard := share.App.AdminRoot
|
|
if dashboard == "" {
|
|
dashboard = "yao"
|
|
}
|
|
|
|
metadata := YaoMetadata{
|
|
Name: share.App.Name,
|
|
Version: share.App.Version,
|
|
Description: share.App.Description,
|
|
OpenAPI: openapi.Config.BaseURL,
|
|
IssuerURL: openapi.Config.OAuth.IssuerURL,
|
|
ServerURL: resolveServerURL(openapi.Config.OAuth.IssuerURL),
|
|
Dashboard: "/" + dashboard,
|
|
Optional: share.App.Optional,
|
|
}
|
|
|
|
// Include developer info if available
|
|
if share.App.Developer.ID != "" || share.App.Developer.Name != "" {
|
|
metadata.Developer = &share.App.Developer
|
|
}
|
|
|
|
c.JSON(200, metadata)
|
|
}
|
|
|
|
// resolveServerURL returns the public server URL for this instance.
|
|
// Priority: YAO_SERVER_URL env > issuer_url origin > empty string.
|
|
func resolveServerURL(issuerURL string) string {
|
|
if v := strings.TrimRight(os.Getenv("YAO_SERVER_URL"), "/"); v != "" {
|
|
return v
|
|
}
|
|
// Strip path from issuer_url to get just the origin (scheme + host + port)
|
|
if issuerURL != "" {
|
|
if idx := strings.Index(issuerURL, "://"); idx != -1 {
|
|
rest := issuerURL[idx+3:]
|
|
if slash := strings.Index(rest, "/"); slash != -1 {
|
|
return issuerURL[:idx+3] + rest[:slash]
|
|
}
|
|
}
|
|
return issuerURL
|
|
}
|
|
return ""
|
|
}
|
|
|
|
// oauthServerMetadata returns authorization server metadata - RFC 8414
|
|
func (openapi *OpenAPI) oauthServerMetadata(c *gin.Context) {}
|
|
|
|
// oauthOpenIDConfiguration returns OpenID Connect configuration
|
|
func (openapi *OpenAPI) oauthOpenIDConfiguration(c *gin.Context) {}
|
|
|
|
// oauthProtectedResourceMetadata returns protected resource metadata - RFC 9728
|
|
func (openapi *OpenAPI) oauthProtectedResourceMetadata(c *gin.Context) {}
|