api: init api

Author: gosunuts

Makefile

@@ -7,6 +7,9 @@ run:
 test-e2e:
 	go test -v $(ROOT_DIR)/test/e2e
 
+generate-api:
+	swag init -g api/server.go -o api/swagger --parseDependency
+
 generate-abi:
 	abigen --abi $(ROOT_DIR)/scheme/evm/eip3009/eip3009.abi \
 		--pkg eip3009 \

README.md

@@ -12,4 +12,9 @@ It Supports facilitator and client roles on EVM-compatible chains.
 # How to run
 ```bash
 docker compose up
-```
+```
+
+# Api Specification
+```
+/swagger/index.html
+```

api/server.go

@@ -1,31 +1,40 @@
 package api
 
 import (
+	"encoding/base64"
+	"encoding/json"
 	"net/http"
 
+	"github.com/go-playground/validator/v10"
 	"github.com/labstack/echo/v4"
 	echomiddleware "github.com/labstack/echo/v4/middleware"
+	_ "github.com/rabbitprincess/x402-facilitator/api/swagger"
+	echoSwagger "github.com/swaggo/echo-swagger"
+
 	"github.com/rabbitprincess/x402-facilitator/api/middleware"
 	"github.com/rabbitprincess/x402-facilitator/facilitator"
+	"github.com/rabbitprincess/x402-facilitator/types"
 )
 
-// server represents the HTTP server for the API
+// @title        x402 Facilitator API
+// @version      1.0
+// @description  API server for x402 payment facilitator
+// @host         localhost:8080
+// @BasePath     /
+// @schemes      http
 type server struct {
 	*echo.Echo
 	facilitator facilitator.Facilitator
 }
 
-// Ensure server implements http.Handler
 var _ http.Handler = (*server)(nil)
 
-// NewServer creates and configures a new API server
 func NewServer(facilitator facilitator.Facilitator) *server {
 	s := &server{
 		Echo:        echo.New(),
 		facilitator: facilitator,
 	}
 
-	// Register middleware
 	s.Use(middleware.RequestID())
 	s.Use(middleware.Logger())
 	s.Use(middleware.ErrorWrapper())
@@ -34,9 +43,114 @@ func NewServer(facilitator facilitator.Facilitator) *server {
 	}))
 	s.Use(echomiddleware.CORS())
 
-	// Register routes
 	s.POST("/verify", s.Verify)
 	s.POST("/settle", s.Settle)
+	s.GET("/supported", s.Supported)
+	s.GET("/swagger/*", echoSwagger.WrapHandler)
 
 	return s
 }
+
+var (
+	validate = validator.New(validator.WithRequiredStructEnabled())
+)
+
+// Settle handles payment settlement requests
+// @Summary      Settle payment
+// @Description  Settle a payment using the facilitator
+// @Tags         payments
+// @Accept       json
+// @Produce      json
+// @Param        body  body      types.PaymentSettleRequest  true  "Settlement request"
+// @Success      200   {object}  types.PaymentSettleResponse
+// @Failure      400   {object}  echo.HTTPError
+// @Failure      500   {object}  echo.HTTPError
+// @Router       /settle [post]
+func (s *server) Settle(c echo.Context) error {
+	ctx := c.Request().Context()
+
+	requirement := &types.PaymentSettleRequest{}
+	if err := json.NewDecoder(c.Request().Body).Decode(requirement); err != nil {
+		return echo.NewHTTPError(http.StatusBadRequest, "Received malformed settlement request")
+	}
+	if err := validate.Struct(requirement); err != nil {
+		return echo.NewHTTPError(http.StatusBadRequest, "Received invalid settlement request")
+	}
+	payment := &types.PaymentPayload{}
+	paymentDecoded, err := base64.StdEncoding.DecodeString(requirement.PaymentHeader)
+	if err != nil {
+		return echo.NewHTTPError(http.StatusBadRequest, "Received malformed Payment header")
+	}
+	if err := json.Unmarshal(paymentDecoded, payment); err != nil {
+		return echo.NewHTTPError(http.StatusBadRequest, "Received malformed Payment header")
+	}
+	if err := validate.Struct(payment); err != nil {
+		return echo.NewHTTPError(http.StatusBadRequest, "Received invalid Payment header")
+	}
+	settle, err := s.facilitator.Settle(ctx, payment, &requirement.PaymentRequirements)
+	if err != nil {
+		return echo.NewHTTPError(http.StatusInternalServerError, err.Error())
+	}
+	return c.JSON(http.StatusOK, settle)
+}
+
+// Verify handles payment verification requests
+// @Summary      Verify payment
+// @Description  Verify a payment using the facilitator
+// @Tags         payments
+// @Accept       json
+// @Produce      json
+// @Param        body  body      types.PaymentVerifyRequest  true  "Payment verification request"
+// @Success      200   {object}  types.PaymentVerifyResponse
+// @Failure      400   {object}  echo.HTTPError
+// @Failure      500   {object}  echo.HTTPError
+// @Router       /verify [post]
+func (s *server) Verify(c echo.Context) error {
+	ctx := c.Request().Context()
+
+	// validate payment requirements
+	requirement := &types.PaymentVerifyRequest{}
+	if err := json.NewDecoder(c.Request().Body).Decode(requirement); err != nil {
+		return echo.NewHTTPError(http.StatusBadRequest, "Received malformed payment requirements")
+	}
+	if err := validate.Struct(requirement); err != nil {
+		return echo.NewHTTPError(http.StatusBadRequest, "Received invalid payment requirements")
+	}
+
+	// validate payment payload
+	payment := &types.PaymentPayload{}
+	paymentDecoded, err := base64.StdEncoding.DecodeString(requirement.PaymentHeader)
+	if err != nil {
+		return echo.NewHTTPError(http.StatusBadRequest, "Received malformed Payment header")
+	}
+	if err := json.Unmarshal(paymentDecoded, payment); err != nil {
+		return echo.NewHTTPError(http.StatusBadRequest, "Received malformed Payment header")
+	}
+	if err := validate.Struct(payment); err != nil {
+		return echo.NewHTTPError(http.StatusBadRequest, "Received invalid Payment header")
+	}
+
+	verified, err := s.facilitator.Verify(ctx, payment, &requirement.PaymentRequirements)
+	if err != nil {
+		return echo.NewHTTPError(http.StatusInternalServerError, err.Error())
+	}
+
+	return c.JSON(http.StatusOK, verified)
+}
+
+// Supported returns the list of supported payment kinds
+// @Summary      List supported kinds
+// @Description  Get supported payment kinds
+// @Tags         payments
+// @Produce      json
+// @Success      200  {array}   types.SupportedKind
+// @Failure      404  {object}  echo.HTTPError
+// @Router       /supported [get]
+func (s *server) Supported(c echo.Context) error {
+	kinds := s.facilitator.Supported()
+	if len(kinds) == 0 {
+		return echo.NewHTTPError(http.StatusNotFound, "No supported payment kinds found")
+	}
+
+	return c.JSON(http.StatusOK, kinds)
+}