IDocumentationBasePath Interface
Defines the base path under which automatically generated OpenAPI documents should be hosted.
public interface IDocumentationBasePathFields
Section titled “Fields”IDocumentationBasePath.DEFAULT Field
Section titled “IDocumentationBasePath.DEFAULT Field”The default path base for automatically generated documentation in an HTTP API.
const string DEFAULT = "documentation";Field Value
Section titled “Field Value”Properties
Section titled “Properties”IDocumentationBasePath.Value Property
Section titled “IDocumentationBasePath.Value Property”The path to use. Must not start or end with a “/”.
string Value { get; }Property Value
Section titled “Property Value”Methods
Section titled “Methods”IDocumentationBasePath.ToString() Method
Section titled “IDocumentationBasePath.ToString() Method”Converts this instance to its string representation which is equal to Value.
string? ToString();Returns
Section titled “Returns”IDocumentationBasePath.TryValidate() Method
Section titled “IDocumentationBasePath.TryValidate() Method”Validates the value of this instance.
bool TryValidate();Returns
Section titled “Returns”System.Boolean
true if successful, false otherwise.
IDocumentationBasePath.TryValidate(string) Method
Section titled “IDocumentationBasePath.TryValidate(string) Method”Validates that the given value does not start or end with a “/”.
static bool TryValidate(string value);Parameters
Section titled “Parameters”value System.String
The path base to validate.
Returns
Section titled “Returns”System.Boolean
true if successful, false otherwise.
Was this page helpful?Thanks for your feedback!