maxmustermann/OpenAPI.NET.OData
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

continue on cleaning the codes

Browse source
This commit is contained in:
Sam Xu 2017-11-13 12:43:08 -08:00
parent 50294db26a
commit 45eedf6c75
13 changed files with 50 additions and 319 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
src/Microsoft.OpenApi.OData.Reader/Abstracts/IOpenApiExtensible.cs
View file

@ -11,7 +11,7 @@ namespace Microsoft.OpenApi.OData
/// <summary>
/// Represents an Extensible Open API element.
/// </summary>
internal interface IOpenApiExtensible : IOpenApiElement
internal interface IOpenApiExtensible //: IOpenApiElement
{
/// <summary>
/// Specification extensions.

2
src/Microsoft.OpenApi.OData.Reader/Abstracts/IOpenApiReferencable.cs
View file

@ -9,7 +9,7 @@ namespace Microsoft.OpenApi.OData
/// <summary>
/// Represents an Open API element is referencable.
/// </summary>
internal interface IOpenApiReferencable : IOpenApiElement
internal interface IOpenApiReferencable //: IOpenApiElement
{
/// <summary>
/// Reference object.

2
src/Microsoft.OpenApi.OData.Reader/Abstracts/IOpenApiWritable.cs
View file

@ -9,7 +9,7 @@ namespace Microsoft.OpenApi.OData
/// <summary>
/// Represents an Open API element is writable.
/// </summary>
internal interface IOpenApiWritable : IOpenApiElement
internal interface IOpenApiWritable //: IOpenApiElement
{
/// <summary>
/// Write Open API element.

8
src/Microsoft.OpenApi.OData.Reader/EdmHelper.cs
View file

@ -18,7 +18,7 @@ namespace Microsoft.OpenApi.OData
{
public static string GetDescription(this IEdmModel model, IEdmEntitySet entitySet)
{
return null;
}
public static string GetDescription(this IEdmModel model, IEdmVocabularyAnnotatable element)
@ -79,12 +79,12 @@ namespace Microsoft.OpenApi.OData
switch (edmType.TypeKind)
{
case EdmTypeKind.Collection:
return AnyTypeKind.Array.GetDisplayName();
return AnyType.Array.GetDisplayName();
case EdmTypeKind.Complex:
case EdmTypeKind.Entity:
case EdmTypeKind.EntityReference:
return AnyTypeKind.Object.GetDisplayName();
return AnyType.Object.GetDisplayName();
case EdmTypeKind.Enum:
return "string";
@ -93,7 +93,7 @@ namespace Microsoft.OpenApi.OData
return ((IEdmPrimitiveType)(edmType)).GetOpenApiDataType().GetCommonName();
default:
return AnyTypeKind.Null.GetDisplayName();
return AnyType.Null.GetDisplayName();
}
}
}

116
src/Microsoft.OpenApi.OData.Reader/EdmModelOpenApiExtensions.cs
View file

@ -1,116 +0,0 @@
//---------------------------------------------------------------------
// <copyright file="EdmModelOpenApiExtensions.cs" company="Microsoft">
// Copyright (C) Microsoft Corporation. All rights reserved. See License.txt in the project root for license information.
// </copyright>
//---------------------------------------------------------------------
using System.IO;
using Microsoft.OData.Edm;
using Microsoft.OpenApi;
using Microsoft.OpenApi.Models;
using Microsoft.OpenApi.Writers;
namespace Microsoft.OpenApi.OData
{
/// <summary>
/// Extension methods to write Entity Data Model (EDM) to Open API.
/// </summary>
public static class EdmModelOpenApiExtensions
{
/// <summary>
/// Outputs Edm model to an Open API artifact to the give stream.
/// </summary>
/// <param name="model">Edm model to be written.</param>
/// <param name="stream">The output stream.</param>
/// <param name="target">The Open API target.</param>
/// <param name="settings">Settings for the generated Open API.</param>
public static void WriteOpenApi(this IEdmModel model, Stream stream, OpenApiFormat target, OpenApiWriterSettings settings = null)
{
if (model == null)
{
throw Error.ArgumentNull(nameof(model));
}
if (stream == null)
{
throw Error.ArgumentNull(nameof(stream));
}
IOpenApiWriter openApiWriter = BuildWriter(stream, target);
model.WriteOpenApi(openApiWriter, settings);
}
/// <summary>
/// Outputs Edm model to an Open API artifact to the give text writer.
/// </summary>
/// <param name="model">Edm model to be written.</param>
/// <param name="writer">The output text writer.</param>
/// <param name="target">The Open API target.</param>
/// <param name="settings">Settings for the generated Open API.</param>
public static void WriteOpenApi(this IEdmModel model, TextWriter writer, OpenApiFormat target, OpenApiWriterSettings settings = null)
{
if (model == null)
{
throw Error.ArgumentNull(nameof(model));
}
if (writer == null)
{
throw Error.ArgumentNull(nameof(writer));
}
IOpenApiWriter openApiWriter = BuildWriter(writer, target);
model.WriteOpenApi(openApiWriter, settings);
}
/// <summary>
/// Outputs an Open API artifact to the provided Open Api writer.
/// </summary>
/// <param name="model">Model to be written.</param>
/// <param name="writer">The generated Open API writer <see cref="IOpenApiWriter"/>.</param>
/// <param name="settings">Settings for the generated Open API.</param>
public static void WriteOpenApi(this IEdmModel model, IOpenApiWriter writer, OpenApiWriterSettings settings = null)
{
if (model == null)
{
throw Error.ArgumentNull("model");
}
if (writer == null)
{
throw Error.ArgumentNull("writer");
}
if (settings == null)
{
settings = new OpenApiWriterSettings();
}
EdmOpenApiDocumentGenerator converter = new EdmOpenApiDocumentGenerator(model, settings);
OpenApiDocument doc = converter.Generate();
doc.Serialize(writer);
}
private static IOpenApiWriter BuildWriter(Stream stream, OpenApiFormat target)
{
StreamWriter writer = new StreamWriter(stream)
{
NewLine = "\n"
};
return BuildWriter(writer, target);
}
private static IOpenApiWriter BuildWriter(TextWriter writer, OpenApiFormat target)
{
if (target == OpenApiFormat.Json)
{
return new OpenApiJsonWriter(writer);
}
else
{
return new OpenApiYamlWriter(writer);
}
}
}
}

121
src/Microsoft.OpenApi.OData.Reader/EdmModelOpenApiExtensions2.cs
View file

@ -1,121 +0,0 @@
//---------------------------------------------------------------------
// <copyright file="EdmModelOpenApiExtensions.cs" company="Microsoft">
// Copyright (C) Microsoft Corporation. All rights reserved. See License.txt in the project root for license information.
// </copyright>
//---------------------------------------------------------------------
using System.IO;
using Microsoft.OData.Edm;
using Microsoft.OpenApi;
using Microsoft.OpenApi.Models;
using Microsoft.OpenApi.Writers;
using System;
namespace Microsoft.OpenApi.OData
{
/// <summary>
/// Extension methods to write Entity Data Model (EDM) to Open API.
/// </summary>
public static class EdmModelOpenApiMappingExtensions
{
/// <summary>
/// Outputs Edm model to an Open API artifact to the give stream.
/// </summary>
/// <param name="model">Edm model to be written.</param>
/// <param name="stream">The output stream.</param>
/// <param name="target">The Open API target.</param>
/// <param name="settings">Settings for the generated Open API.</param>
public static OpenApiDocument Mapping(this IEdmModel model)
{
if (model == null)
{
throw Error.ArgumentNull(nameof(model));
}
return new OpenApiDocument();
}
public static OpenApiDocument Mapping(this IEdmModel model, Action<OpenApiDocument> configure)
{
if (model == null)
{
throw Error.ArgumentNull(nameof(model));
}
return new OpenApiDocument();
}
/// <summary>
/// Outputs Edm model to an Open API artifact to the give text writer.
/// </summary>
/// <param name="model">Edm model to be written.</param>
/// <param name="writer">The output text writer.</param>
/// <param name="target">The Open API target.</param>
/// <param name="settings">Settings for the generated Open API.</param>
public static void WriteOpenApi(this IEdmModel model, TextWriter writer, OpenApiFormat target, OpenApiWriterSettings settings = null)
{
if (model == null)
{
throw Error.ArgumentNull(nameof(model));
}
if (writer == null)
{
throw Error.ArgumentNull(nameof(writer));
}
IOpenApiWriter openApiWriter = BuildWriter(writer, target);
model.WriteOpenApi(openApiWriter, settings);
}
/// <summary>
/// Outputs an Open API artifact to the provided Open Api writer.
/// </summary>
/// <param name="model">Model to be written.</param>
/// <param name="writer">The generated Open API writer <see cref="IOpenApiWriter"/>.</param>
/// <param name="settings">Settings for the generated Open API.</param>
public static void WriteOpenApi(this IEdmModel model, IOpenApiWriter writer, OpenApiWriterSettings settings = null)
{
if (model == null)
{
throw Error.ArgumentNull("model");
}
if (writer == null)
{
throw Error.ArgumentNull("writer");
}
if (settings == null)
{
settings = new OpenApiWriterSettings();
}
EdmOpenApiDocumentGenerator converter = new EdmOpenApiDocumentGenerator(model, settings);
OpenApiDocument doc = converter.Generate();
doc.Serialize(writer);
}
private static IOpenApiWriter BuildWriter(Stream stream, OpenApiFormat target)
{
StreamWriter writer = new StreamWriter(stream)
{
NewLine = "\n"
};
return BuildWriter(writer, target);
}
private static IOpenApiWriter BuildWriter(TextWriter writer, OpenApiFormat target)
{
if (target == OpenApiFormat.Json)
{
return new OpenApiJsonWriter(writer);
}
else
{
return new OpenApiYamlWriter(writer);
}
}
}
}

35
src/Microsoft.OpenApi.OData.Reader/EdmModelOpenApiMappingExtensions.cs
View file

@ -4,12 +4,9 @@
// </copyright>
//---------------------------------------------------------------------
using System.IO;
using Microsoft.OData.Edm;
using Microsoft.OpenApi;
using Microsoft.OpenApi.Models;
using Microsoft.OpenApi.Writers;
using System;
using Microsoft.OData.Edm;
using Microsoft.OpenApi.Models;
namespace Microsoft.OpenApi.OData
{
@ -19,30 +16,24 @@ namespace Microsoft.OpenApi.OData
public static class EdmModelOpenApiMappingExtensions
{
/// <summary>
/// Outputs Edm model to an Open API artifact to the give stream.
///
/// </summary>
/// <param name="model">Edm model to be written.</param>
/// <param name="stream">The output stream.</param>
/// <param name="target">The Open API target.</param>
/// <param name="settings">Settings for the generated Open API.</param>
/// <param name="model"></param>
/// <returns></returns>
public static OpenApiDocument Convert(this IEdmModel model)
{
if (model == null)
{
throw Error.ArgumentNull(nameof(model));
}
return new OpenApiDocument();
return new OpenApiDocumentGenerator(model).Generate();
}
/// <summary>
///
/// </summary>
/// <param name="model"></param>
/// <param name="configure"></param>
/// <returns></returns>
public static OpenApiDocument Convert(this IEdmModel model, Action<OpenApiDocument> configure)
{
if (model == null)
{
throw Error.ArgumentNull(nameof(model));
}
return new OpenApiDocument();
return new OpenApiDocumentGenerator(model, configure).Generate();
}
}
}

28
src/Microsoft.OpenApi.OData.Reader/EdmOpenApiExtensions.cs
View file

@ -1,28 +0,0 @@
//---------------------------------------------------------------------
// <copyright file="ODataOpenApiConvert.cs" company="Microsoft">
// Copyright (C) Microsoft Corporation. All rights reserved. See License.txt in the project root for license information.
// </copyright>
//---------------------------------------------------------------------
using Microsoft.OData.Edm;
using Microsoft.OpenApi.Models;
using System;
namespace Microsoft.OpenApi.OData
{
/// <summary>
///
/// </summary>
public static class EdmOpenApiExtensions
{
public static OpenApiDocument Convert(this IEdmModel model)
{
return model.Convert(configure: null);
}
public static OpenApiDocument Convert(this IEdmModel model, Action<OpenApiDocument> configure)
{
return new OpenApiDocumentGenerator(model, settings).Generate();
}
}
}

6
src/Microsoft.OpenApi.OData.Reader/Microsoft.OpenAPI.OData.Reader.csproj
View file

@ -20,11 +20,7 @@
</PropertyGroup>
<ItemGroup>
<Compile Remove="EdmModelOpenApiMappingExtensions.cs" />
</ItemGroup>
<ItemGroup>
<Compile Include="OpenApiPathsGenerator.cs" />
<Compile Remove="EdmModelOpenApiExtensions2.cs" />
</ItemGroup>
<ItemGroup>

8
src/Microsoft.OpenApi.OData.Reader/ODataOpenApiConvert.cs
View file

@ -11,18 +11,18 @@ using System;
namespace Microsoft.OpenApi.OData
{
/// <summary>
///
/// Convert <see cref="IEdmModel"/> to Open API document, <see cref="OpenApiDocument"/>.
/// </summary>
public static class EdmOpenApiExtensions
public static class EdmModelOpenApiExtensions
{
public static OpenApiDocument Convert(this IEdmModel model)
{
return model.Convert(configure: null);
return new OpenApiDocumentGenerator(model).Generate();
}
public static OpenApiDocument Convert(this IEdmModel model, Action<OpenApiDocument> configure)
{
return new OpenApiDocumentGenerator(model, settings).Generate();
return new OpenApiDocumentGenerator(model, configure).Generate();
}
}
}

18
src/Microsoft.OpenApi.OData.Reader/OpenApiComponentsGenerator.cs
View file

@ -16,7 +16,7 @@ namespace Microsoft.OpenApi.OData
/// </summary>
internal class OpenApiComponentsGenerator
{
private OpenApiComponents _components;
private IEdmModel _model;
/// <summary>
/// Initializes a new instance of the <see cref="OpenApiComponentsGenerator" /> class.
@ -25,6 +25,7 @@ namespace Microsoft.OpenApi.OData
/// <param name="settings">The Open Api writer settings.</param>
public OpenApiComponentsGenerator(IEdmModel model)
{
_model = model ?? throw Error.ArgumentNull(nameof(model));
}
/// <summary>
@ -33,23 +34,18 @@ namespace Microsoft.OpenApi.OData
/// <returns>the components object.</returns>
public OpenApiComponents Generate()
{
if (_components == null)
return new OpenApiComponents
{
_components = new OpenApiComponents
{
Schemas = VisitSchemas(),
Parameters = VisitParameters()
};
}
return _components;
Schemas = VisitSchemas(),
Parameters = VisitParameters()
};
}
private IDictionary<string, OpenApiSchema> VisitSchemas()
{
IDictionary<string, OpenApiSchema> schemas = new Dictionary<string, OpenApiSchema>();
foreach (var element in Model.SchemaElements)
foreach (var element in _model.SchemaElements)
{
switch (element.SchemaElementKind)
{

21
src/Microsoft.OpenApi.OData.Reader/OpenApiDocumentGenerator.cs
View file

@ -17,7 +17,6 @@ namespace Microsoft.OpenApi.OData
/// </summary>
internal class OpenApiDocumentGenerator
{
private OpenApiDocument _openApiDoc;
private OpenApiComponentsGenerator _componentsGenerator;
private OpenApiPathsGenerator _pathsGenerator;
@ -26,8 +25,20 @@ namespace Microsoft.OpenApi.OData
/// </summary>
protected IEdmModel Model { get; }
/// <summary>
/// The Open Api document external configuration action.
/// </summary>
private Action<OpenApiDocument> _configure;
/// <summary>
///
/// </summary>
/// <param name="model"></param>
public OpenApiDocumentGenerator(IEdmModel model)
: this(model, null)
{
}
/// <summary>
/// Initializes a new instance of the <see cref="EdmOpenApiDocumentGenerator" /> class.
/// </summary>
@ -35,7 +46,7 @@ namespace Microsoft.OpenApi.OData
/// <param name="settings">The Open Api writer settings.</param>
public OpenApiDocumentGenerator(IEdmModel model, Action<OpenApiDocument> configure)
{
Model = model;
Model = model ?? throw Error.ArgumentNull(nameof(model));
_configure = configure;
_componentsGenerator = new OpenApiComponentsGenerator(model);
_pathsGenerator = new OpenApiPathsGenerator(model);
@ -73,7 +84,7 @@ namespace Microsoft.OpenApi.OData
/// <returns>The info object.</returns>
private OpenApiInfo CreateInfo()
{
// The value of info is an Info Object,
// The value of info is an Info Object,
// It contains the fields title and version, and optionally the field description.
return new OpenApiInfo
{
@ -84,13 +95,13 @@ namespace Microsoft.OpenApi.OData
// The value of version is the value of the annotation Core.SchemaVersion(see[OData - VocCore]) of the main schema.
// If no Core.SchemaVersion is present, a default version has to be provided as this is a required OpenAPI field.
Version = new Version(1, 0, 0),
Version = "1.0.0",
// The value of description is the value of the annotation Core.LongDescription
// of the main schema or the entity container.
// While this field is optional, it prominently appears in OpenAPI exploration tools,
// so a default description should be provided if no Core.LongDescription annotation is present.
Description = "This OData service is located at " + Settings.BaseUri?.OriginalString
// Description = "This OData service is located at " + Settings.BaseUri?.OriginalString
};
}

2
test/Microsoft.OpenAPI.OData.Reader.Tests/EdmModelOpenApiExtensionsTest.cs
View file

@ -13,6 +13,7 @@ namespace Microsoft.OpenApi.OData.Tests
{
public class EdmModelOpenApiExtensionsTest
{
#if false
[Fact]
public void EmptyEdmModelToOpenApiJsonWorks()
{
@ -110,5 +111,6 @@ namespace Microsoft.OpenApi.OData.Tests
stream.Position = 0;
return new StreamReader(stream).ReadToEnd();
}
#endif
}
}