Document how to ignore common links without repetition
Closes gh-177
This commit is contained in:
34
docs/src/test/java/com/example/Hypermedia.java
Normal file
34
docs/src/test/java/com/example/Hypermedia.java
Normal file
@@ -0,0 +1,34 @@
|
||||
/*
|
||||
* Copyright 2014-2016 the original author or authors.
|
||||
*
|
||||
* 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.
|
||||
*/
|
||||
|
||||
package com.example;
|
||||
|
||||
import org.springframework.restdocs.hypermedia.HypermediaDocumentation;
|
||||
import org.springframework.restdocs.hypermedia.LinkDescriptor;
|
||||
import org.springframework.restdocs.hypermedia.LinksSnippet;
|
||||
|
||||
import static org.springframework.restdocs.hypermedia.HypermediaDocumentation.linkWithRel;
|
||||
|
||||
public class Hypermedia {
|
||||
|
||||
// tag::ignore-links[]
|
||||
public static LinksSnippet links(LinkDescriptor... descriptors) {
|
||||
return HypermediaDocumentation.links(linkWithRel("_self").ignored().optional(),
|
||||
linkWithRel("curies").ignored()).and(descriptors);
|
||||
}
|
||||
// end::ignore-links[]
|
||||
|
||||
}
|
||||
Reference in New Issue
Block a user