mirror of
https://github.com/wiremock/WireMock.Net.git
synced 2026-02-16 15:27:42 +01:00
5ed09d84a3
* . * Use ILRepack to include Microsoft.OpenApi as internal * ... * OpenApiSpecificationVersion * . * 080 * 4
74 lines
3.4 KiB
C#
74 lines
3.4 KiB
C#
// Copyright © WireMock.Net
|
|
|
|
using System.Collections.Generic;
|
|
using System.IO;
|
|
using WireMock.Admin.Mappings;
|
|
using WireMock.Net.OpenApiParser.Models;
|
|
using WireMock.Net.OpenApiParser.Settings;
|
|
|
|
namespace WireMock.Net.OpenApiParser;
|
|
|
|
/// <summary>
|
|
/// Parse a OpenApi/Swagger/V2/V3 or Raml to WireMock MappingModels.
|
|
/// </summary>
|
|
public interface IWireMockOpenApiParser
|
|
{
|
|
/// <summary>
|
|
/// Generate <see cref="IReadOnlyList{MappingModel}"/> from a file-path.
|
|
/// </summary>
|
|
/// <param name="path">The path to read the OpenApi/Swagger/V2/V3/V31 or Raml file.</param>
|
|
/// <param name="diagnostic">OpenApiDiagnostic output</param>
|
|
/// <returns>MappingModel</returns>
|
|
IReadOnlyList<MappingModel> FromFile(string path, out OpenApiDiagnostic diagnostic);
|
|
|
|
/// <summary>
|
|
/// Generate <see cref="IReadOnlyList{MappingModel}"/> from a file-path.
|
|
/// </summary>
|
|
/// <param name="path">The path to read the OpenApi/Swagger/V2/V3/V31 or Raml file.</param>
|
|
/// <param name="settings">Additional settings</param>
|
|
/// <param name="diagnostic">OpenApiDiagnostic output</param>
|
|
/// <returns>MappingModel</returns>
|
|
IReadOnlyList<MappingModel> FromFile(string path, WireMockOpenApiParserSettings settings, out OpenApiDiagnostic diagnostic);
|
|
|
|
/// <summary>
|
|
/// Generate <see cref="IReadOnlyList{MappingModel}"/> from an Microsoft.OpenApi.Models.OpenApiDocument.
|
|
/// </summary>
|
|
/// <param name="document">The source OpenApiDocument</param>
|
|
/// <param name="settings">Additional settings [optional]</param>
|
|
/// <returns>MappingModel</returns>
|
|
IReadOnlyList<MappingModel> FromDocument(object document, WireMockOpenApiParserSettings? settings = null);
|
|
|
|
/// <summary>
|
|
/// Generate <see cref="IReadOnlyList{MappingModel}"/> from a <seealso cref="Stream"/>.
|
|
/// </summary>
|
|
/// <param name="stream">The source stream</param>
|
|
/// <param name="diagnostic">OpenApiDiagnostic output</param>
|
|
/// <returns>MappingModel</returns>
|
|
IReadOnlyList<MappingModel> FromStream(Stream stream, out OpenApiDiagnostic diagnostic);
|
|
|
|
/// <summary>
|
|
/// Generate <see cref="IReadOnlyList{MappingModel}"/> from a <seealso cref="Stream"/>.
|
|
/// </summary>
|
|
/// <param name="stream">The source stream</param>
|
|
/// <param name="settings">Additional settings</param>
|
|
/// <param name="diagnostic">OpenApiDiagnostic output</param>
|
|
/// <returns>MappingModel</returns>
|
|
IReadOnlyList<MappingModel> FromStream(Stream stream, WireMockOpenApiParserSettings settings, out OpenApiDiagnostic diagnostic);
|
|
|
|
/// <summary>
|
|
/// Generate <see cref="IReadOnlyList{MappingModel}"/> from a <seealso cref="string"/>.
|
|
/// </summary>
|
|
/// <param name="text">The source text</param>
|
|
/// <param name="diagnostic">OpenApiDiagnostic output</param>
|
|
/// <returns>MappingModel</returns>
|
|
IReadOnlyList<MappingModel> FromText(string text, out OpenApiDiagnostic diagnostic);
|
|
|
|
/// <summary>
|
|
/// Generate <see cref="IReadOnlyList{MappingModel}"/> from a <seealso cref="string"/>.
|
|
/// </summary>
|
|
/// <param name="text">The source text</param>
|
|
/// <param name="settings">Additional settings</param>
|
|
/// <param name="diagnostic">OpenApiDiagnostic output</param>
|
|
/// <returns>MappingModel</returns>
|
|
IReadOnlyList<MappingModel> FromText(string text, WireMockOpenApiParserSettings settings, out OpenApiDiagnostic diagnostic);
|
|
} |