vincent/aptly
1
0
Fork 0
mirror of https://github.com/aptly-dev/aptly.git synced 2026-07-16 12:08:04 +00:00
Code Issues Projects Releases Wiki Activity

[debian] disable swagger

Browse Source
This commit is contained in:
André Roth
2024-10-15 12:09:33 +02:00
parent 38e97a274d
commit 1f02d49fdb
4 changed files with 30 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files
api/router.go
+26 -26
View File
@@ -11,9 +11,9 @@ import (
"github.com/prometheus/client_golang/prometheus/promhttp" "github.com/prometheus/client_golang/prometheus/promhttp"
"github.com/rs/zerolog/log" "github.com/rs/zerolog/log"
"github.com/aptly-dev/aptly/docs" // _ "github.com/aptly-dev/aptly/docs" // import docs
swaggerFiles "github.com/swaggo/files" // swaggerFiles "github.com/swaggo/files"
ginSwagger "github.com/swaggo/gin-swagger" // ginSwagger "github.com/swaggo/gin-swagger"
) )
var context *ctx.AptlyContext var context *ctx.AptlyContext
@@ -25,21 +25,21 @@ func apiMetricsGet() gin.HandlerFunc {
} }
} }
func redirectSwagger(c *gin.Context) { // func redirectSwagger(c *gin.Context) {
if c.Request.URL.Path == "/docs/index.html" { // if c.Request.URL.Path == "/docs/index.html" {
c.Redirect(http.StatusMovedPermanently, "/docs.html") // c.Redirect(http.StatusMovedPermanently, "/docs.html")
return // return
} // }
if c.Request.URL.Path == "/docs/" { // if c.Request.URL.Path == "/docs/" {
c.Redirect(http.StatusMovedPermanently, "/docs.html") // c.Redirect(http.StatusMovedPermanently, "/docs.html")
return // return
} // }
if c.Request.URL.Path == "/docs" { // if c.Request.URL.Path == "/docs" {
c.Redirect(http.StatusMovedPermanently, "/docs.html") // c.Redirect(http.StatusMovedPermanently, "/docs.html")
return // return
} // }
c.Next() // c.Next()
} // }
// Router returns prebuilt with routes http.Handler // Router returns prebuilt with routes http.Handler
func Router(c *ctx.AptlyContext) http.Handler { func Router(c *ctx.AptlyContext) http.Handler {
@@ -63,14 +63,14 @@ func Router(c *ctx.AptlyContext) http.Handler {
router.Use(gin.Recovery(), gin.ErrorLogger()) router.Use(gin.Recovery(), gin.ErrorLogger())
if c.Config().EnableSwaggerEndpoint { // if c.Config().EnableSwaggerEndpoint {
router.GET("docs.html", func(c *gin.Context) { // router.GET("docs.html", func(c *gin.Context) {
c.Data(http.StatusOK, "text/html; charset=utf-8", docs.DocsHTML) // c.Data(http.StatusOK, "text/html; charset=utf-8", docs.DocsHTML)
}) // })
router.Use(redirectSwagger) // router.Use(redirectSwagger)
url := ginSwagger.URL("/docs/doc.json") // url := ginSwagger.URL("/docs/doc.json")
router.GET("/docs/*any", ginSwagger.WrapHandler(swaggerFiles.Handler, url)) // router.GET("/docs/*any", ginSwagger.WrapHandler(swaggerFiles.Handler, url))
} // }
if c.Config().EnableMetricsEndpoint { if c.Config().EnableMetricsEndpoint {
MetricsCollectorRegistrar.Register(router) MetricsCollectorRegistrar.Register(router)
docs/index.go → docs/index.go.disabled
View File
man/aptly.1
+2 -1
View File
@@ -111,8 +111,9 @@ The legacy json configuration is still supported (and also supports comments):
// Enable metrics for Prometheus client // Enable metrics for Prometheus client
"enableMetricsEndpoint": false, "enableMetricsEndpoint": false,
// Not implemented in this version\.
// Enable API documentation on /docs // Enable API documentation on /docs
"enableSwaggerEndpoint": false, //"enableSwaggerEndpoint": false,
// OBSOLETE: use via url param ?_async=true // OBSOLETE: use via url param ?_async=true
"AsyncAPI": false, "AsyncAPI": false,
man/aptly.1.ronn.tmpl
+2 -1
View File
@@ -100,8 +100,9 @@ The legacy json configuration is still supported (and also supports comments):
// Enable metrics for Prometheus client // Enable metrics for Prometheus client
"enableMetricsEndpoint": false, "enableMetricsEndpoint": false,
// Not implemented in this version.
// Enable API documentation on /docs // Enable API documentation on /docs
"enableSwaggerEndpoint": false, //"enableSwaggerEndpoint": false,
// OBSOLETE: use via url param ?_async=true // OBSOLETE: use via url param ?_async=true
"AsyncAPI": false, "AsyncAPI": false,