org.springframework.restdocs.http.HttpDocumentation.java Source code

Introduction

Here is the source code for org.springframework.restdocs.http.HttpDocumentation.java

Source

/*
 * 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
 *
 *      https://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 org.springframework.restdocs.http;

import java.util.Map;

/**
 * Static factory methods for documenting a RESTful API's HTTP requests.
 *
 * @author Andy Wilkinson
 * @author Jonathan Pearlin
 */
public abstract class HttpDocumentation {

    private HttpDocumentation() {

    }

    /**
     * Returns a new {@code Snippet} that will document the HTTP request for the API
     * operation.
     * @return the snippet that will document the HTTP request
     */
    public static HttpRequestSnippet httpRequest() {
        return new HttpRequestSnippet();
    }

    /**
     * Returns a new {@code Snippet} that will document the HTTP request for the API
     * operation. The given {@code attributes} will be available during snippet
     * generation.
     * @param attributes the attributes
     * @return the snippet that will document the HTTP request
     */
    public static HttpRequestSnippet httpRequest(Map<String, Object> attributes) {
        return new HttpRequestSnippet(attributes);
    }

    /**
     * Returns a {@code Snippet} that will document the HTTP response for the API
     * operation.
     * @return the snippet that will document the HTTP response
     */
    public static HttpResponseSnippet httpResponse() {
        return new HttpResponseSnippet();
    }

    /**
     * Returns a {@code Snippet} that will document the HTTP response for the API
     * operation. The given {@code attributes} will be available during snippet
     * generation.
     * @param attributes the attributes
     * @return the snippet that will document the HTTP response
     */
    public static HttpResponseSnippet httpResponse(Map<String, Object> attributes) {
        return new HttpResponseSnippet(attributes);
    }

}