AutoBE
    Preparing search index...

    Interface IResponseBody

    Response body information for OpenAPI operation.

    This interface defines the structure of a successful response from an API operation. It provides a description of the response and a schema reference to define the returned data structure.

    The content-type for all responses is always application/json. Even when file downloading is required, don't use application/octet-stream or multipart/form-data content types. Instead, just define an URI string property in the response body schema.

    In OpenAPI, this might represent:

    {
      "responses": {
        "200": {
          "description": "Order information",
          "content": {
            "application/json": {
              "schema": { "$ref": "#/components/schemas/IShoppingOrder" }
            }
          }
        }
      }
    }
    interface IResponseBody {
        description: string;
        typeName: string;
    }
    Index

    Properties

    description typeName

    Properties

    description: string

    Description about the response body.

    Make short, concise and clear description about the response body.

    MUST be written in English. Never use other languages.

    typeName: string

    Response body's data type.

    Specifies the structure of the returned data (response body), that will be transformed to AutoBeOpenApi.IJsonSchema.IReference type in the components section as an object type.

    Here is the naming convention for the response body type:

    • IEntityName: Main entity with detailed information (e.g., IShoppingSale)
    • IEntityName.ISummary: Simplified response version with essential properties
    • IEntityName.IInvert: Alternative view of an entity from a different perspective
    • IPageIEntityName: Paginated results container with pagination and data properties

    What you write:

    {
      "typeName": "IShoppingOrder"
    }

    Transformed to:

    {
      "schema": {
        "$ref": "#/components/schemas/IShoppingOrder"
      }
    }

    Settings

    Member Visibility

    On This Page

    Properties