6b84493ca9## Motivation and Context Currently there's a lot of unsafe manual JSON unmarshalling/marshalling, and we have to manually keep the openapi schema in sync. This PR migrates the API to [Huma](https://github.com/danielgtaylor/huma), which appears like a popular, well-maintained way to build APIs in Golang. I'm not a Golang expert, but seemed highly recommended by Reddit + Claude and has a decent star count. It provides automatic openapi spec generation and docs hosting, JSON parsing, as well as the ability to add auth middlewares etc. ## How Has This Been Tested? Running locally, and poking at the endpoints ## Breaking Changes Docs are served at `/docs` rather than `/v0/swagger/index.html` now ## Types of changes <!-- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> - [ ] Bug fix (non-breaking change which fixes an issue) - [x] New feature (non-breaking change which adds functionality) - [x] Breaking change (fix or feature that would cause existing functionality to change) - [x] Documentation update ## Checklist <!-- Go over all the following points, and put an `x` in all the boxes that apply. --> - [x] I have read the [MCP Documentation](https://modelcontextprotocol.io) - [x] My code follows the repository's style guidelines - [x] New and existing tests pass locally - [x] I have added appropriate error handling - [x] I have added or updated documentation as needed ## Additional context <!-- Add any other context, implementation notes, or design decisions -->
34 lines
976 B
Go
34 lines
976 B
Go
package v0
|
|
|
|
import (
|
|
"context"
|
|
"net/http"
|
|
|
|
"github.com/danielgtaylor/huma/v2"
|
|
"github.com/modelcontextprotocol/registry/internal/config"
|
|
)
|
|
|
|
// HealthBody represents the health check response body
|
|
type HealthBody struct {
|
|
Status string `json:"status" example:"ok" doc:"Health status"`
|
|
GitHubClientID string `json:"github_client_id,omitempty" doc:"GitHub OAuth App Client ID"`
|
|
}
|
|
|
|
// RegisterHealthEndpoint registers the health check endpoint
|
|
func RegisterHealthEndpoint(api huma.API, cfg *config.Config) {
|
|
huma.Register(api, huma.Operation{
|
|
OperationID: "get-health",
|
|
Method: http.MethodGet,
|
|
Path: "/v0/health",
|
|
Summary: "Health check",
|
|
Description: "Check the health status of the API",
|
|
Tags: []string{"health"},
|
|
}, func(_ context.Context, _ *struct{}) (*Response[HealthBody], error) {
|
|
return &Response[HealthBody]{
|
|
Body: HealthBody{
|
|
Status: "ok",
|
|
GitHubClientID: cfg.GithubClientID,
|
|
},
|
|
}, nil
|
|
})
|
|
}
|