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 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 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();
}
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 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();
}
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);
}
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 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 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();
}
public static void WriteServer(IParseNodeWriter writer, Server server)
{
writer.WriteStartMap();
writer.WriteStringProperty("url", server.Url);
writer.WriteStringProperty("description", server.Description);
writer.WriteMap("variables", server.Variables, WriteServerVariable);
writer.WriteExtensions(server.Extensions);
writer.WriteEndMap();
}
public static void WriteLink(IParseNodeWriter writer, Link link)
{
writer.WriteStartMap();
writer.WriteStringProperty("href", link.Href);
writer.WriteStringProperty("operationId", link.OperationId);
writer.WriteMap("parameters", link.Parameters, (w, x) => { w.WriteValue(x.ToString()); });
writer.WriteExtensions(link.Extensions);
writer.WriteEndMap();
}
public static void WriteRequestBody(IParseNodeWriter writer, RequestBody requestBody)
{
writer.WriteStartMap();
writer.WriteStringProperty("description", requestBody.Description);
writer.WriteBoolProperty("required", requestBody.Required, false);
writer.WriteMap("content", requestBody.Content, WriteMediaType);
writer.WriteExtensions(requestBody.Extensions);
writer.WriteEndMap();
}
public static void WriteServerVariable(IParseNodeWriter writer, ServerVariable variable)
{
writer.WriteStartMap();
writer.WriteList("enum", variable.Enum, (nodeWriter, s) => nodeWriter.WriteValue(s));
writer.WriteStringProperty("default", variable.Default);
writer.WriteStringProperty("description", variable.Description);
writer.WriteExtensions(variable.Extensions);
writer.WriteEndMap();
}
public static void WriteExample(IParseNodeWriter writer, Example example)
{
writer.WriteStartMap();
writer.WriteStringProperty("summary", example.Summary);
writer.WriteStringProperty("description", example.Description);
if (example.Value != null)
{
writer.WritePropertyName("value");
example.Value.Write(writer);
}
writer.WriteExtensions(example.Extensions);
writer.WriteEndMap();
}
public static void WriteInfo(IParseNodeWriter writer, Info info)
{
writer.WriteStartMap();
writer.WriteStringProperty("title", info.Title);
writer.WriteStringProperty("description", info.Description);
writer.WriteStringProperty("termsOfService", info.TermsOfService);
writer.WriteObject("contact", info.Contact, WriteContact);
writer.WriteObject("license", info.License, WriteLicense);
writer.WriteStringProperty("version", info.Version);
writer.WriteExtensions(info.Extensions);
writer.WriteEndMap();
}
public static void WriteResponse(IParseNodeWriter writer, Response response)
{
writer.WriteStartMap();
writer.WriteStringProperty("description", response.Description);
writer.WriteMap("content", response.Content, WriteMediaType);
writer.WriteMap("headers", response.Headers, WriteHeaderOrReference);
writer.WriteMap("links", response.Links, WriteLinkOrReference);
writer.WriteExtensions(response.Extensions);
//Links
writer.WriteEndMap();
}
public static void WriteComponents(IParseNodeWriter writer, Components components)
{
writer.WriteStartMap();
writer.WriteMap("schemas", components.Schemas, WriteSchema);
writer.WriteMap("responses", components.Responses, WriteResponse);
writer.WriteMap("parameters", components.Parameters, WriteParameter);
writer.WriteMap("examples", components.Examples, WriteExample);
writer.WriteMap("requestBodies", components.RequestBodies, WriteRequestBody);
writer.WriteMap("headers", components.Headers, WriteHeader);
writer.WriteMap("securitySchemes", components.SecuritySchemes, WriteSecurityScheme);
writer.WriteMap("links", components.Links, WriteLink);
writer.WriteMap("callbacks", components.Callbacks, WriteCallback);
writer.WriteExtensions(components.Extensions);
writer.WriteEndMap();
}
public static void WriteParameter(IParseNodeWriter writer, Parameter parameter)
{
writer.WriteStartMap();
writer.WriteStringProperty("name", parameter.Name);
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.WriteStringProperty("style", parameter.Style);
writer.WriteBoolProperty("explode", parameter.Explode, false);
writer.WriteBoolProperty("allowReserved", parameter.AllowReserved, false);
writer.WriteObject("schema", parameter.Schema, WriteSchemaOrReference);
writer.WriteList("examples", parameter.Examples, AnyNode.Write);
writer.WriteObject("example", parameter.Example, AnyNode.Write);
writer.WriteMap("content", parameter.Content, WriteMediaType);
writer.WriteExtensions(parameter.Extensions);
writer.WriteEndMap();
}
public static void WriteHeader(IParseNodeWriter writer, Header header)
{
writer.WriteStartMap();
writer.WriteStringProperty("description", header.Description);
writer.WriteBoolProperty("required", header.Required, false);
writer.WriteBoolProperty("deprecated", header.Deprecated, false);
writer.WriteBoolProperty("allowEmptyValue", header.AllowEmptyValue, false);
writer.WriteStringProperty("style", header.Style);
writer.WriteBoolProperty("explode", header.Explode, false);
writer.WriteBoolProperty("allowReserved", header.AllowReserved, false);
writer.WriteObject("schema", header.Schema, WriteSchema);
writer.WriteList("examples", header.Examples, AnyNode.Write);
writer.WriteObject("example", header.Example, AnyNode.Write);
writer.WriteMap("content", header.Content, WriteMediaType);
writer.WriteExtensions(header.Extensions);
writer.WriteEndMap();
}
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);
writer.WriteList <Parameter>("parameters", operation.Parameters, WriteParameterOrReference);
writer.WriteObject("requestBody", operation.RequestBody, WriteRequestBodyOrReference);
writer.WriteMap <Response>("responses", operation.Responses, WriteResponseOrReference);
writer.WriteMap <Callback>("callbacks", operation.Callbacks, WriteCallbackOrReference);
writer.WriteBoolProperty("deprecated", operation.Deprecated, Operation.DeprecatedDefault);
writer.WriteList("security", operation.Security, WriteSecurityRequirement);
writer.WriteList("servers", operation.Servers, WriteServer);
writer.WriteExtensions(operation.Extensions);
writer.WriteEndMap();
}
public static void WriteSecurityScheme(IParseNodeWriter writer, SecurityScheme securityScheme)
{
writer.WriteStartMap();
writer.WriteStringProperty("type", securityScheme.Type);
switch (securityScheme.Type)
{
case "http":
writer.WriteStringProperty("scheme", securityScheme.Scheme);
writer.WriteStringProperty("bearerFormat", securityScheme.BearerFormat);
break;
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();
}
