Package org.springdoc.core.fn.builders.apiresponse

Class Builder

  • public class Builder
extends Object
    The type Api response builder.
    Author:
    bnasslahsen

    • Method Detail

      • responseBuilder

        public static Builder responseBuilder()
        Builder api response builder.
        Returns:
        the api response builder

      • description

        public Builder description​(String description)
        Description api response builder.
        Parameters:
        description - the description
        Returns:
        the api response builder

      • responseCode

        public Builder responseCode​(String responseCode)
        Response code api response builder.
        Parameters:
        responseCode - the response code
        Returns:
        the api response builder

      • header

        public Builder header​(Builder headers)
        Header api response builder.
        Parameters:
        headers - the headers
        Returns:
        the api response builder

      • link

        public Builder link​(Builder linkBuilder)
        Link api response builder.
        Parameters:
        linkBuilder - the link builder
        Returns:
        the api response builder

      • content

        public Builder content​(Builder contentBuilder)
        Content api response builder.
        Parameters:
        contentBuilder - the content builder
        Returns:
        the api response builder

      • implementation

        public Builder implementation​(Class clazz)
        Implementation api response builder.
        Parameters:
        clazz - the clazz
        Returns:
        the api response builder

      • implementationArray

        public Builder implementationArray​(Class clazz)
        Implementation array api response builder.
        Parameters:
        clazz - the clazz
        Returns:
        the api response builder

      • extension

        public Builder extension​(Builder extensionBuilder)
        Extension api response builder.
        Parameters:
        extensionBuilder - the extension builder
        Returns:
        the api response builder

      • ref

        public Builder ref​(String ref)
        Ref api response builder.
        Parameters:
        ref - the ref
        Returns:
        the api response builder

      • build

        public io.swagger.v3.oas.annotations.responses.ApiResponse build()
        Build api response.
        Returns:
        the api response