public static void WriteResponse(IParseNodeWriter writer, Response response)
{
writer.WriteStartMap();
writer.WriteStringProperty("description", response.Description);
if (response.Content != null)
{
var mediatype = response.Content.FirstOrDefault();
if (mediatype.Value != null)
{
writer.WriteObject("schema", mediatype.Value.Schema, WriteSchemaOrReference);
if (mediatype.Value.Example != null)
{
writer.WritePropertyName("examples");
writer.WriteStartMap();
writer.WritePropertyName(mediatype.Key);
AnyNode.Write(writer, mediatype.Value.Example);
writer.WriteEndMap();
}
}
}
writer.WriteMap("headers", response.Headers, WriteHeaderOrReference);
writer.WriteExtensions(response.Extensions);
writer.WriteEndMap();
}
void IModel.Write(IParseNodeWriter writer)
{
writer.WriteStartMap();
writer.WritePropertyName("openapi");
writer.WriteValue("3.0.0");
writer.WriteObject("info", Info, ModelHelper.Write);
writer.WriteList("servers", Servers, ModelHelper.Write);
writer.WritePropertyName("paths");
if (Paths.PathItems.Count() > 0)
{
ModelHelper.Write(writer, Paths);
}
else
{
writer.WriteValue("{}");
}
writer.WriteList("tags", Tags, ModelHelper.Write);
if (!Components.IsEmpty())
{
writer.WriteObject("components", Components, ModelHelper.Write);
}
if (ExternalDocs.Url != null)
{
writer.WriteObject("externalDocs", ExternalDocs, ModelHelper.Write);
}
writer.WriteList("security", SecurityRequirements, ModelHelper.Write);
writer.WriteEndMap();
}
public static void WriteSecurityScheme(IParseNodeWriter writer, SecurityScheme securityScheme)
{
writer.WriteStartMap();
if (securityScheme.Type == "http")
{
if (securityScheme.Scheme == "basic")
{
writer.WriteStringProperty("type", "basic");
}
}
else
{
writer.WriteStringProperty("type", securityScheme.Type);
}
switch (securityScheme.Type)
{
case "oauth2":
//writer.WriteStringProperty("scheme", this.Scheme);
//TODO:
case "apiKey":
writer.WriteStringProperty("in", securityScheme.In);
writer.WriteStringProperty("name", securityScheme.Name);
break;
}
writer.WriteExtensions(securityScheme.Extensions);
writer.WriteEndMap();
}
public static void WriteTag(IParseNodeWriter writer, Tag tag)
{
writer.WriteStartMap();
writer.WriteStringProperty("name", tag.Name);
writer.WriteStringProperty("description", tag.Description);
writer.WriteEndMap();
}
public static void WriteParameter(IParseNodeWriter writer, Parameter parameter)
{
writer.WriteStartMap();
writer.WriteStringProperty("name", parameter.Name);
if (parameter is BodyParameter)
{
writer.WriteStringProperty("in", "body"); // form?
}
else
{
writer.WriteStringProperty("in", parameter.In.ToString());
}
writer.WriteStringProperty("description", parameter.Description);
writer.WriteBoolProperty("required", parameter.Required, false);
writer.WriteBoolProperty("deprecated", parameter.Deprecated, false);
writer.WriteBoolProperty("allowEmptyValue", parameter.AllowEmptyValue, false);
writer.WriteBoolProperty("allowReserved", parameter.AllowReserved, false);
if (parameter is BodyParameter)
{
writer.WriteObject("schema", parameter.Schema, WriteSchemaOrReference);
}
else
{
WriteSchemaProperties(writer, parameter.Schema);
}
// writer.WriteList("examples", parameter.Examples, AnyNode.Write);
// writer.WriteObject("example", parameter.Example, AnyNode.Write);
writer.WriteExtensions(parameter.Extensions);
writer.WriteEndMap();
}
public static void WriteComponents(IParseNodeWriter writer, Components components)
{
writer.WriteMap("definitions", components.Schemas, WriteSchema);
writer.WriteMap("responses", components.Responses, WriteResponse);
writer.WriteMap("parameters", components.Parameters, WriteParameter);
writer.WriteMap("securityDefinitions", components.SecuritySchemes, WriteSecurityScheme);
}
public static void WriteExternalDocs(IParseNodeWriter writer, ExternalDocs externalDocs)
{
writer.WriteStartMap();
writer.WriteStringProperty("description", externalDocs.Description);
writer.WriteStringProperty("url", externalDocs.Url?.OriginalString);
writer.WriteEndMap();
}
public static void WriteOpenApiDocument(IParseNodeWriter writer, OpenApiDocument doc)
{
writer.WriteStartMap();
writer.WritePropertyName("openapi");
writer.WriteValue("3.0.0");
writer.WriteObject("info", doc.Info, WriteInfo);
writer.WriteList("servers", doc.Servers, WriteServer);
writer.WritePropertyName("paths");
writer.WriteStartMap();
WritePaths(writer, doc.Paths);
writer.WriteEndMap();
writer.WriteList("tags", doc.Tags, WriteTag);
if (!doc.Components.IsEmpty())
{
writer.WriteObject("components", doc.Components, WriteComponents);
}
if (doc.ExternalDocs.Url != null)
{
writer.WriteObject("externalDocs", doc.ExternalDocs, WriteExternalDocs);
}
writer.WriteList("security", doc.SecurityRequirements, WriteSecurityRequirement);
writer.WriteExtensions(doc.Extensions);
writer.WriteEndMap();
}
public static void WritePathItem(IParseNodeWriter writer, PathItem pathItem)
{
writer.WriteStartMap();
writer.WriteStringProperty("summary", pathItem.Summary);
writer.WriteStringProperty("description", pathItem.Description);
if (pathItem.Parameters != null && pathItem.Parameters.Count > 0)
{
writer.WritePropertyName("parameters");
writer.WriteStartList();
foreach (var parameter in pathItem.Parameters)
{
WriteParameter(writer, parameter);
}
writer.WriteEndList();
}
writer.WriteList("servers", pathItem.Servers, WriteServer);
foreach (var operationPair in pathItem.Operations)
{
writer.WritePropertyName(operationPair.Key);
WriteOperation(writer, operationPair.Value);
}
writer.WriteExtensions(pathItem.Extensions);
writer.WriteEndMap();
}
void IModel.Write(IParseNodeWriter writer)
{
writer.WriteStartMap();
writer.WriteStringProperty("description", this.Description);
writer.WriteStringProperty("url", this.Url?.OriginalString);
writer.WriteEndMap();
}
void IModel.Write(IParseNodeWriter writer)
{
writer.WriteStartMap();
writer.WriteStringProperty("name", Name);
writer.WriteStringProperty("description", Description);
writer.WriteEndMap();
}
public override void Write(IParseNodeWriter writer)
{
if (nodeList == null || !nodeList.Children.Any())
{
return;
}
writer.WriteStartList();
if (!(nodeList.Children.First() is YamlScalarNode scalarNode))
{
return;
}
bool stringFormat = scalarNode.Style == ScalarStyle.SingleQuoted ||
scalarNode.Style == ScalarStyle.DoubleQuoted;
var items = nodeList.Children.Select(x => (x as YamlScalarNode).Value).ToList();
items.ForEach(s =>
{
if (stringFormat)
{
writer.WriteListItem(s, (nodeWriter, item) => nodeWriter.WriteValue(item));
}
else
{
writer.WriteListItem((object)s, (nodeWriter, item) => nodeWriter.WriteValue(item));
}
});
writer.WriteEndList();
}
public static void WriteNumberProperty(this IParseNodeWriter writer, string name, decimal value, decimal?defaultValue = null)
{
if (defaultValue == null || value != defaultValue)
{
writer.WritePropertyName(name);
writer.WriteValue(value);
}
}
public static void WriteStringProperty(this IParseNodeWriter writer, string name, string value)
{
if (!String.IsNullOrEmpty(value))
{
writer.WritePropertyName(name);
writer.WriteValue(value);
}
}
public static void WriteObject <T>(this IParseNodeWriter writer, string propertyName, T entity, Action <IParseNodeWriter, T> parser)
{
if (entity != null)
{
writer.WritePropertyName(propertyName);
parser(writer, entity);
}
}
public static void WriteSchema(IParseNodeWriter writer, Schema schema)
{
writer.WriteStartMap();
WriteSchemaProperties(writer, schema);
writer.WriteEndMap();
}
public static void WriteNumberProperty(this IParseNodeWriter writer, string name, decimal?value)
{
if (value != null)
{
writer.WritePropertyName(name);
writer.WriteValue((decimal)value);
}
}
void IModel.Write(IParseNodeWriter writer)
{
writer.WriteStartMap();
writer.WriteStringProperty("href", Href);
writer.WriteStringProperty("operationId", OperationId);
writer.WriteMap("parameters", Parameters, (w, x) => { w.WriteValue(x.ToString()); });
writer.WriteEndMap();
}
void IModel.Write(IParseNodeWriter writer)
{
writer.WriteStartMap();
writer.WriteStringProperty("name", Name);
writer.WriteStringProperty("url", Url?.OriginalString);
writer.WriteEndMap();
}
public static void WritePaths(IParseNodeWriter writer, Paths paths)
{
foreach (var pathItem in paths.PathItems)
{
writer.WritePropertyName(pathItem.Key);
WritePathItem(writer, pathItem.Value);
}
writer.WriteExtensions(paths.Extensions);
}
public static void WriteOperation(IParseNodeWriter writer, Operation operation)
{
writer.WriteStartMap();
writer.WriteList("tags", operation.Tags, Tag.WriteRef);
writer.WriteStringProperty("summary", operation.Summary);
writer.WriteStringProperty("description", operation.Description);
writer.WriteObject("externalDocs", operation.ExternalDocs, WriteExternalDocs);
writer.WriteStringProperty("operationId", operation.OperationId);
var parameters = new List <Parameter>(operation.Parameters);
Parameter bodyParameter = null;
if (operation.RequestBody != null)
{
writer.WritePropertyName("consumes");
writer.WriteStartList();
var consumes = operation.RequestBody.Content.Keys.Distinct();
foreach (var mediaType in consumes)
{
writer.WriteListItem(mediaType, (w, s) => w.WriteValue(s));
}
writer.WriteEndList();
// Create bodyParameter
bodyParameter = new BodyParameter()
{
Name = "body",
Description = operation.RequestBody.Description,
Schema = operation.RequestBody.Content.First().Value.Schema
};
// add to parameters
parameters.Add(bodyParameter);
}
var produces = operation.Responses.Where(r => r.Value.Content != null).SelectMany(r => r.Value.Content?.Keys).Distinct();
if (produces.Count() > 0)
{
writer.WritePropertyName("produces");
writer.WriteStartList();
foreach (var mediaType in produces)
{
writer.WriteListItem(mediaType, (w, s) => w.WriteValue(s));
}
writer.WriteEndList();
}
writer.WriteList <Parameter>("parameters", parameters, WriteParameterOrReference);
writer.WriteMap <Response>("responses", operation.Responses, WriteResponseOrReference);
writer.WriteBoolProperty("deprecated", operation.Deprecated, Operation.DeprecatedDefault);
writer.WriteList("security", operation.Security, WriteSecurityRequirement);
writer.WriteExtensions(operation.Extensions);
writer.WriteEndMap();
}
private static void WriteSchemaProperties(IParseNodeWriter writer, Schema schema)
{
writer.WriteStringProperty("title", schema.Title);
writer.WriteStringProperty("type", schema.Type);
writer.WriteStringProperty("format", schema.Format);
writer.WriteStringProperty("description", schema.Description);
writer.WriteNumberProperty("maxLength", schema.MaxLength);
writer.WriteNumberProperty("minLength", schema.MinLength);
writer.WriteStringProperty("pattern", schema.Pattern);
writer.WriteStringProperty("default", schema.Default);
writer.WriteList("required", schema.Required, (nodeWriter, s) => nodeWriter.WriteValue(s));
writer.WriteNumberProperty("maximum", schema.Maximum);
writer.WriteBoolProperty("exclusiveMaximum", schema.ExclusiveMaximum, false);
writer.WriteNumberProperty("minimum", schema.Minimum);
writer.WriteBoolProperty("exclusiveMinimum", schema.ExclusiveMinimum, false);
if (schema.AdditionalProperties != null)
{
writer.WritePropertyName("additionalProperties");
WriteSchemaOrReference(writer, schema.AdditionalProperties);
}
if (schema.Items != null)
{
writer.WritePropertyName("items");
WriteSchemaOrReference(writer, schema.Items);
}
writer.WriteNumberProperty("maxItems", schema.MaxItems);
writer.WriteNumberProperty("minItems", schema.MinItems);
if (schema.Properties != null)
{
writer.WritePropertyName("properties");
writer.WriteStartMap();
foreach (var prop in schema.Properties)
{
writer.WritePropertyName(prop.Key);
if (prop.Value != null)
{
WriteSchemaOrReference(writer, prop.Value);
}
else
{
writer.WriteValue("null");
}
}
writer.WriteEndMap();
}
writer.WriteNumberProperty("maxProperties", schema.MaxProperties);
writer.WriteNumberProperty("minProperties", schema.MinProperties);
writer.WriteList("enum", schema.Enum, (nodeWriter, s) => nodeWriter.WriteValue(s));
writer.WriteExtensions(schema.Extensions);
}
void IModel.Write(IParseNodeWriter writer)
{
writer.WriteStartMap();
foreach (var pathItem in PathItems)
{
writer.WritePropertyName(pathItem.Key);
pathItem.Value.Write(writer);
}
writer.WriteEndMap();
}
public override void Write(IParseNodeWriter writer)
{
if (node.Style == ScalarStyle.DoubleQuoted || node.Style == ScalarStyle.SingleQuoted)
{
writer.WriteValue(node.Value);
return;
}
writer.WriteValue((object)node.Value);
}
public static void WriteLicense(IParseNodeWriter writer, License license)
{
writer.WriteStartMap();
writer.WriteStringProperty("name", license.Name);
writer.WriteStringProperty("url", license.Url?.OriginalString);
writer.WriteExtensions(license.Extensions);
writer.WriteEndMap();
}
public static void WriteCallback(IParseNodeWriter writer, Callback callback)
{
writer.WriteStartMap();
foreach (var item in callback.PathItems)
{
writer.WriteObject <PathItem>(item.Key.Expression, item.Value, WritePathItem);
}
writer.WriteExtensions(callback.Extensions);
writer.WriteEndMap();
}
public static void WriteMediaType(IParseNodeWriter writer, MediaType mediaType)
{
writer.WriteStartMap();
writer.WriteObject("schema", mediaType.Schema, WriteSchemaOrReference);
writer.WriteObject("example", mediaType.Example, AnyNode.Write);
writer.WriteMap("examples", mediaType.Examples, WriteExampleOrReference);
writer.WriteEndMap();
}
void IModel.Write(IParseNodeWriter writer)
{
writer.WriteStartMap();
writer.WriteStringProperty("url", Url);
writer.WriteStringProperty("description", Description);
writer.WriteMap("variables", Variables, ModelHelper.Write);
writer.WriteEndMap();
}
void IModel.Write(IParseNodeWriter writer)
{
writer.WriteStartMap();
writer.WriteStringProperty("description", Description);
writer.WriteBoolProperty("required", Required, false);
writer.WriteMap("content", Content, ModelHelper.Write);
writer.WriteEndMap();
}
public static void WriteContact(IParseNodeWriter writer, Contact contact)
{
writer.WriteStartMap();
writer.WriteStringProperty("name", contact.Name);
writer.WriteStringProperty("url", contact.Url?.OriginalString);
writer.WriteStringProperty("email", contact.Email);
writer.WriteExtensions(contact.Extensions);
writer.WriteEndMap();
}
