Skip to content

Add flag to change redirect on home page #102

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add flag to change redirect on home page #102

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion config/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
Copyright (C) 2016-2017 dapperdox.com
Copyright (C) 2016-2017 dapperdox.com

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
Expand Down Expand Up @@ -39,6 +39,7 @@ type config struct {
SpecRewriteURL []string `env:"SPEC_REWRITE_URL" flag:"spec-rewrite-url" flagDesc:"The URLs in the swagger specifications to be rewritten as site-url"`
DocumentRewriteURL []string `env:"DOCUMENT_REWRITE_URL" flag:"document-rewrite-url" flagDesc:"Specify a document URL that is to be rewritten. May be multiply defined. Format is from=to."`
ForceSpecList bool `env:"FORCE_SPECIFICATION_LIST" flag:"force-specification-list" flagDesc:"Force the homepage to be the summary list of available specifications. The default when serving a single OpenAPI specification is to make the homepage the API summary."`
HomeRedirect string `env:"HOME_REDIRECT" flag:"home-redirect" flagDesc:"Where should home redirect to if there is only 1 specification"`
ShowAssets bool `env:"AUTHOR_SHOW_ASSETS" flag:"author-show-assets" flagDesc:"Display at the foot of each page the overlay asset paths, in priority order, that DapperDox will check before rendering."`
ProxyPath []string `env:"PROXY_PATH" flag:"proxy-path" flagDesc:"Give a path to proxy though to another service. May be multiply defined. Format is local-path=scheme://host/dst-path."`
TLSCertificate string `env:"TLS_CERTIFICATE" flag:"tls-certificate" flagDesc:"The fully qualified path to the TLS certificate file. For HTTP over TLS (HTTPS) both a certificate and a key must be provided."`
Expand All @@ -60,6 +61,7 @@ func Get() (*config, error) {
LogLevel: "info",
SiteURL: "http://localhost:3123/",
ShowAssets: false,
HomeRedirect: "reference",
}

err := gofigure.Gofigure(cfg)
Expand Down
8 changes: 4 additions & 4 deletions handlers/home/home.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,13 @@ func Register(r *pat.Router) {
// Homepages for each loaded specification
var specification *spec.APISpecification // Ends up being populated with the last spec processed

cfg, _ := config.Get()

for _, specification = range spec.APISuite {

logger.Tracef(nil, "Build homepage route for specification '%s'", specification.ID)

r.Path("/" + specification.ID + "/reference").Methods("GET").HandlerFunc(specificationSummaryHandler(specification))
r.Path("/" + specification.ID+"/"+cfg.HomeRedirect).Methods("GET").HandlerFunc(specificationSummaryHandler(specification))

// If missingh trailing slash, redirect to add it
r.Path("/" + specification.ID).Methods("GET").HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
Expand All @@ -50,13 +52,11 @@ func Register(r *pat.Router) {
count++
}

cfg, _ := config.Get()

if count == 1 && cfg.ForceSpecList == false {
// If there is only one specification loaded, then hotwire '/' to redirect to the
// specification summary page unless DapperDox is configured to show the specification list page.
r.Path("/").Methods("GET").HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
http.Redirect(w, req, "/"+specification.ID+"/reference", 302)
http.Redirect(w, req, "/"+specification.ID+"/"+cfg.HomeRedirect, 302)
})
} else {
r.Path("/").Methods("GET").HandlerFunc(specificationListHandler)
Expand Down