mirror of
https://github.com/usememos/memos.git
synced 2024-09-21 14:55:59 +08:00
4491c75135
* - Refactor several API routes from anonymous functions to regular definitions. Required to add parseable documentation comments.
- Add API documentation comments using Swag Declarative Comments Format
- Add echo-swagger to serve Swagger-UI at /api/index.html
- Fix error response from extraneous parameter resourceId to relatedMemoId in DELETE("/memo/:memoId/relation/:relatedMemoId/type/:relationType")
- Add an auto-generated ./docs/api/v1.md for quick reference on repo (generated by swagger-markdown)
- Add auxiliary scripts to generate docs.go and swagger.yaml
* fix: golangci-lint errors
* fix: go fmt flag in swag scripts
78 lines
2.4 KiB
Go
78 lines
2.4 KiB
Go
package v1
|
|
|
|
import (
|
|
"fmt"
|
|
"net/http"
|
|
"net/url"
|
|
|
|
"github.com/labstack/echo/v4"
|
|
getter "github.com/usememos/memos/plugin/http-getter"
|
|
)
|
|
|
|
func (*APIV1Service) registerGetterPublicRoutes(g *echo.Group) {
|
|
// GET /get/httpmeta?url={url} - Get website meta.
|
|
g.GET("/get/httpmeta", httpmeta)
|
|
|
|
// GET /get/image?url={url} - Get image.
|
|
g.GET("/get/image", image)
|
|
}
|
|
|
|
// httpmeta godoc
|
|
//
|
|
// @Summary Get website metadata
|
|
// @Tags get
|
|
// @Produce json
|
|
// @Param url query string true "Website URL"
|
|
// @Success 200 {object} getter.HTMLMeta "Extracted metadata"
|
|
// @Failure 400 {object} nil "Missing website url | Wrong url"
|
|
// @Failure 406 {object} nil "Failed to get website meta with url: %s"
|
|
// @Router /o/get/httpmeta [GET]
|
|
func httpmeta(c echo.Context) error {
|
|
urlStr := c.QueryParam("url")
|
|
if urlStr == "" {
|
|
return echo.NewHTTPError(http.StatusBadRequest, "Missing website url")
|
|
}
|
|
if _, err := url.Parse(urlStr); err != nil {
|
|
return echo.NewHTTPError(http.StatusBadRequest, "Wrong url").SetInternal(err)
|
|
}
|
|
|
|
htmlMeta, err := getter.GetHTMLMeta(urlStr)
|
|
if err != nil {
|
|
return echo.NewHTTPError(http.StatusNotAcceptable, fmt.Sprintf("Failed to get website meta with url: %s", urlStr)).SetInternal(err)
|
|
}
|
|
return c.JSON(http.StatusOK, htmlMeta)
|
|
}
|
|
|
|
// image godoc
|
|
//
|
|
// @Summary Get image from URL
|
|
// @Tags get
|
|
// @Produce image/*
|
|
// @Param url query string true "Image url"
|
|
// @Success 200 {object} nil "Image"
|
|
// @Failure 400 {object} nil "Missing image url | Wrong url | Failed to get image url: %s"
|
|
// @Failure 500 {object} nil "Failed to write image blob"
|
|
// @Router /o/get/image [GET]
|
|
func image(c echo.Context) error {
|
|
urlStr := c.QueryParam("url")
|
|
if urlStr == "" {
|
|
return echo.NewHTTPError(http.StatusBadRequest, "Missing image url")
|
|
}
|
|
if _, err := url.Parse(urlStr); err != nil {
|
|
return echo.NewHTTPError(http.StatusBadRequest, "Wrong url").SetInternal(err)
|
|
}
|
|
|
|
image, err := getter.GetImage(urlStr)
|
|
if err != nil {
|
|
return echo.NewHTTPError(http.StatusBadRequest, fmt.Sprintf("Failed to get image url: %s", urlStr)).SetInternal(err)
|
|
}
|
|
|
|
c.Response().Writer.WriteHeader(http.StatusOK)
|
|
c.Response().Writer.Header().Set("Content-Type", image.Mediatype)
|
|
c.Response().Writer.Header().Set(echo.HeaderCacheControl, "max-age=31536000, immutable")
|
|
if _, err := c.Response().Writer.Write(image.Blob); err != nil {
|
|
return echo.NewHTTPError(http.StatusInternalServerError, "Failed to write image blob").SetInternal(err)
|
|
}
|
|
return nil
|
|
}
|