capital.scalable.restdocs.request.PathParametersSnippet Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of spring-auto-restdocs-core Show documentation
Show all versions of spring-auto-restdocs-core Show documentation
Spring Auto REST Docs is an extension to Spring REST Docs
/*-
* #%L
* Spring Auto REST Docs Core
* %%
* Copyright (C) 2015 - 2018 Scalable Capital GmbH
* %%
* 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.
* #L%
*/
package capital.scalable.restdocs.request;
import org.springframework.core.MethodParameter;
import org.springframework.web.bind.annotation.PathVariable;
public class PathParametersSnippet extends AbstractParameterSnippet {
public static final String PATH_PARAMETERS = "auto-path-parameters";
private final boolean failOnUndocumentedParams;
public PathParametersSnippet() {
this(false);
}
public PathParametersSnippet(boolean failOnUndocumentedParams) {
super(PATH_PARAMETERS, null);
this.failOnUndocumentedParams = failOnUndocumentedParams;
}
public PathParametersSnippet failOnUndocumentedParams(boolean failOnUndocumentedParams) {
return new PathParametersSnippet(failOnUndocumentedParams);
}
@Override
protected boolean isRequired(MethodParameter param, PathVariable annot) {
// Spring disallows null for primitive types
return param.getParameterType().isPrimitive() || annot.required();
}
@Override
protected String getPath(PathVariable annot) {
return annot.value();
}
protected PathVariable getAnnotation(MethodParameter param) {
return param.getParameterAnnotation(PathVariable.class);
}
@Override
public String getHeaderKey() {
return "path-parameters";
}
@Override
protected boolean shouldFailOnUndocumentedParams() {
return failOnUndocumentedParams;
}
@Override
protected String getDefaultValue(final PathVariable annotation) {
// @PathVariable does not have a default value
return null;
}
@Override
protected String[] getTranslationKeys() {
return new String[]{
"th-parameter",
"th-type",
"th-optional",
"th-description",
"no-params"
};
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy