Documentation
    Preparing search index...

    Interface IDocument

    Swagger document structure.

    interface IDocument {
        basePath?: string;
        consumes?: string[];
        definitions?: Record<string, SwaggerV2.IJsonSchema>;
        host?: string;
        info?: SwaggerV2.IDocument.IInfo;
        parameters?: Record<string, SwaggerV2.IOperation.IParameter>;
        paths?: Record<string, SwaggerV2.IPath>;
        produces?: string[];
        responses?: Record<string, SwaggerV2.IOperation.IResponse>;
        security?: Record<string, string[]>[];
        securityDefinitions?: Record<string, SwaggerV2.ISecurityDefinition>;
        swagger: `2.0.${number}` | "2.0";
        tags?: SwaggerV2.IDocument.ITag[];
    }
    Index

    Properties

    basePath? consumes? definitions? host? info? parameters? paths? produces? responses? security? securityDefinitions? swagger tags?

    Properties

    basePath?: string

    Base path for all operations.

    consumes?: string[]

    Global content types consumed.

    definitions?: Record<string, SwaggerV2.IJsonSchema>

    Schema definitions.

    host?: string

    Host address.

    info?: SwaggerV2.IDocument.IInfo

    API metadata.

    parameters?: Record<string, SwaggerV2.IOperation.IParameter>

    Reusable parameter definitions.

    paths?: Record<string, SwaggerV2.IPath>

    API paths and operations.

    produces?: string[]

    Global content types produced.

    responses?: Record<string, SwaggerV2.IOperation.IResponse>

    Reusable response definitions.

    security?: Record<string, string[]>[]

    Global security requirements.

    securityDefinitions?: Record<string, SwaggerV2.ISecurityDefinition>

    Security scheme definitions.

    swagger: `2.0.${number}` | "2.0"

    Swagger version.

    tags?: SwaggerV2.IDocument.ITag[]

    Tag definitions.

    Settings

    Member Visibility

    On This Page

    Properties