Description

Sitemap exposure starter for Spring apps.

How to use

1. Implement fun.wilddev.spring.sitemap.api.SiteMapLoader:

@Component
public class ExampleSiteMapLoader implements SiteMapLoader {

    @Override
    public List<SiteMapEntry> load() {
        return List.of(
                new SiteMapEntry("https://test.website/test_1", LocalDateTime.now()),
                new SiteMapEntry("https://test.website/test_2", LocalDateTime.now()),
                new SiteMapEntry("https://test.website/test_3", LocalDateTime.now())
        );
    }
}

2. Access the sitemap endpoint by https://test.website/sitemap/xml:

<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
    <url>
        <loc>https://test.website/test_1</loc>
        <lastmod>2024-11-03T18:24:19Z</lastmod>
    </url>
    <url>
        <loc>https://test.website/test_2</loc>
        <lastmod>2024-11-03T17:11:16Z</lastmod>
    </url>
    <url>
        <loc>https://test.website/test_3</loc>
        <lastmod>2024-11-03T17:54:17Z</lastmod>
    </url>
</urlset>

Get started

Build requirements:

• latest JDK and Maven

Also available in Maven central:

<dependency>
    <groupId>fun.wilddev.lib</groupId>
    <artifactId>spring-starter-sitemap</artifactId>
    <version>1.0.1.RELEASE</version>
</dependency>

License

This project is licensed under the Apache License 2.0.

Dependencies:

• Spring Boot (Apache 2.0)
• FasterXML (Apache 2.0)
• MapStruct (Apache 2.0)
• Lombok (MIT)

See LICENSE and NOTICE files for details.