https://github.com/gregwhitaker/roboto
Module for Spring Boot applications that automatically generates robots.txt and sitemap.xml files
https://github.com/gregwhitaker/roboto
robots seo sitemap spring spring-boot spring-mvc
Last synced: about 2 months ago
JSON representation
Module for Spring Boot applications that automatically generates robots.txt and sitemap.xml files
- Host: GitHub
- URL: https://github.com/gregwhitaker/roboto
- Owner: gregwhitaker
- License: apache-2.0
- Created: 2018-05-22T02:29:30.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-05-27T05:26:36.000Z (about 8 years ago)
- Last Synced: 2025-10-29T09:54:15.008Z (8 months ago)
- Topics: robots, seo, sitemap, spring, spring-boot, spring-mvc
- Language: Java
- Homepage:
- Size: 159 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# roboto
[](https://travis-ci.org/gregwhitaker/roboto)
Module for Spring Boot applications that automatically generates [robots.txt](http://www.robotstxt.org/) and [sitemap.xml](https://www.sitemaps.org/protocol.html) files based on standard
controller annotations.
## How does it work?
1. Simply annotate your main Spring application class with the `@EnableRoboto` annotation like so:
@SpringBootApplication
@EnableRoboto
public class Application {
public static void main(String... args) {
SpringApplication.run(Application.class, args);
}
}
2. Next, use the `@DisallowRobots` annotation to mark methods and/or controllers that you would like to be excluded from search engine indexing.
For Example:
@Controller
@DisallowRobots
public class FooController {
@GetMapping("/foo/1")
public String foo1(Model model) {
model.addAttribute("message", "This is Foo1");
return "foo";
}
@GetMapping("/foo/2")
public String foo2(Model model) {
model.addAttribute("message", "This is Foo2");
return "foo";
}
}
Or
@Controller
public class FooController {
@GetMapping("/foo/1")
@DisallowRobots
public String foo1(Model model) {
model.addAttribute("message", "This is Foo1");
return "foo";
}
@GetMapping("/foo/2")
public String foo2(Model model) {
model.addAttribute("message", "This is Foo2");
return "foo";
}
}
3. That's all there is to it. Your robots.txt and sitemap.xml files are now automatically accessible at `/robots.txt`
and `/sitemap.xml`.
## Getting Roboto
Roboto libraries are available via JCenter.
* [roboto-springboot](https://bintray.com/gregwhitaker/maven/roboto-springboot) - Use this library if you are integrating with Spring Boot.
## Examples
Please see the included [example projects](roboto-examples) for demonstrations on how to configure and use Roboto.
## Bugs and Feedback
For bugs, questions, and discussions please use the [Github Issues](https://github.com/gregwhitaker/roboto/issues).
## License
Copyright 2018 Greg Whitaker
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.