Skip to main content

Definition

Assembly: CloudNimble.Breakdance.DotHttp.dll Namespace: CloudNimble.Breakdance.DotHttp.Models Inheritance: System.Object

Syntax

Summary

Represents a complete parsed .http file containing variables and requests.

Remarks

A .http file can contain multiple requests separated by ### and file-level variables. Variables are case-sensitive per the Microsoft specification.

Examples

Constructors

.ctor

Syntax

.ctor Inherited

Inherited from object

Syntax

Properties

Diagnostics

Gets or sets the parsing diagnostics encountered while parsing this file.

Syntax

Property Value

Type: System.Collections.Generic.List<Microsoft.CodeAnalysis.Diagnostic>

Remarks

Contains Roslyn diagnostic information for malformed content that could not be parsed.

FilePath

Gets or sets the file path relative to the project.

Syntax

Property Value

Type: string

HasChainedRequests

Gets a value indicating whether any requests in this file have dependencies on other requests.

Syntax

Property Value

Type: bool

Remarks

Returns true when any request uses response variable references like {{login.response.body.$.token}}.

Requests

Gets or sets all HTTP requests defined in the file.

Syntax

Property Value

Type: System.Collections.Generic.List<CloudNimble.Breakdance.DotHttp.Models.DotHttpRequest>

Remarks

Requests are separated by ### in the source file.

Variables

Gets or sets the file-level variables defined with @name=value syntax.

Syntax

Property Value

Type: System.Collections.Generic.Dictionary<string, string>

Examples

Remarks

Variable names are case-sensitive per the Microsoft specification.

Methods

Equals Inherited Virtual

Inherited from object

Syntax

Parameters

NameTypeDescription
objobject?-

Returns

Type: bool

Equals Inherited

Inherited from object

Syntax

Parameters

NameTypeDescription
objAobject?-
objBobject?-

Returns

Type: bool

GetHashCode Inherited Virtual

Inherited from object

Syntax

Returns

Type: int

GetType Inherited

Inherited from object

Syntax

Returns

Type: System.Type

MemberwiseClone Inherited

Inherited from object

Syntax

Returns

Type: object

ReferenceEquals Inherited

Inherited from object

Syntax

Parameters

NameTypeDescription
objAobject?-
objBobject?-

Returns

Type: bool

ToString Inherited Virtual

Inherited from object

Syntax

Returns

Type: string?