Skip to content

CLI 自动配置#

Huma 内置支持 OpenAPI 3 扩展,用于启用 CLI 自动配置。这允许像 Restish 这样的工具自动配置自己,以正确的端点、认证机制等与您的 API 通信,而用户无需了解您的 API 的任何信息。

o := api.OpenAPI()
o.Components.SecuritySchemes["my-scheme"] = &huma.SecurityScheme{
	Type: "oauth2",
	// ... security scheme definition ...
}
o.Extensions["x-cli-autoconfig"] = huma.AutoConfig{
	Security: "my-scheme",
	Params: map[string]string{
		"client_id": "abc123",
		"authorize_url": "https://example.tld/authorize",
		"token_url": "https://example.tld/token",
		"scopes": "read,write",
	}
}

有关更多信息,包括如何向用户询问自定义参数,请参阅 CLI 自动配置 文档。