Vapor Sitemap
A dynamic sitemap generator for Vapor.
Setup
Add the package to your Package.swift file:
let package = Package(
// ...
dependencies: [
// 💧 A server-side Swift web framework.
.package(url: "https://github.com/vapor/vapor.git", from: "4.0.0"),
.package(url: "https://github.com/vapor-community/vapor-sitemap.git", from: "1.0.0"), // Add this line
],
targets: [
.target(
name: "App",
dependencies: [
.product(name: "Vapor", package: "vapor"),
.product(name: "VaporSitemap", package: "vapor-sitemap"), // Add this line
]
),
],
// ...
)
Usage
First, we need to create some functions to tell to the middleware what to do:
isSitemap(_ req: Request) -> Bool
The goal of this function is to tell the middleware if it should handle a path or not. A basic implementation is this one:
func isSitemap(_ req: Request) -> Bool {
return req.url.path == "/sitemap.xml"
}
With this implementation, you tell to the middleware to handle only /sitemap.xml.
In some cases, you may want to generate multiple sitemaps. To do so, just handle all the path you want in this function.
generateURLs(_ req: Request) -> [SitemapURL]
The goal of this function is to give all the URLs to put in the specified sitemap. An example implementation is this one:
func generateURLs(_ req: Request) -> [SitemapURL] {
let prefix = "https://www.example.com/"
let paths = ["home", "page1", "folder/page2"]
return paths.map { path in
prefix + path
}
.map(SitemapURL.init)
}
Final step
In your configure.swift, add the corresponding middleware:
app.middleware.use(SitemapMiddleware(
isSitemap: isSitemap,
generateURLs: generateURLs
))
And you're ready to go!
About
This package is developed and maintained by Nathan Fallet.
3 Feb 21, 2022
346 Dec 31, 2022
0 Nov 8, 2021
7 Jun 16, 2022
3 Dec 15, 2022
145 Sep 10, 2022
29 Oct 17, 2022
12 Jun 18, 2022
104 Jan 6, 2023
5 Jul 1, 2022
23 Nov 4, 2022
0 Oct 20, 2021
3 Sep 22, 2022
1 Aug 23, 2022
9 Jun 18, 2022
0 Jan 10, 2022
0 Nov 21, 2021
2 Oct 10, 2022
1 Dec 30, 2021
3 Dec 15, 2022
5 Jul 1, 2022
23 Nov 4, 2022
0 Jan 10, 2022
3 Nov 30, 2021
683 Jan 5, 2023
216 Dec 31, 2022
9 Dec 8, 2022
568 Jan 5, 2023
8.3k Dec 31, 2022