static Info CreateInfoForApiVersion(ApiVersionDescription description)
{
var info = new Info()
{
Title = $"Release Zero {description.ApiVersion}",
Version = description.ApiVersion.ToString(),
Description = "Release Zero API.",
Contact = new Contact()
{
Name = "Chris Gundersen", Email = "*****@*****.**"
},
TermsOfService = "Open Source",
License = new License()
{
Name = "MIT", Url = "https://opensource.org/licenses/MIT"
}
};
if (description.IsDeprecated)
{
info.Description += " This API version has been deprecated.";
}
return(info);
}
private OpenApiInfo CreateInfoForApiVersion(ApiVersionDescription description)
{
var info = new OpenApiInfo
{
Title = string.Format(_openApiInfo.Title ?? "ShaProjectName Api", description.ApiVersion.ToString()),
Version = description.ApiVersion.ToString(),
Description = _openApiInfo.Description,
Contact = new OpenApiContact
{
Name = _openApiInfo.Contact?.Name,
Email = _openApiInfo.Contact?.Email,
Url = _openApiInfo.Contact?.Url
},
TermsOfService = _openApiInfo.TermsOfService,
License = new OpenApiLicense
{
Name = _openApiInfo.License?.Name,
Url = _openApiInfo.License?.Url
}
};
if (description.IsDeprecated)
{
info.Description += " This API version has been deprecated.";
}
return(info);
}
static Info CreateInfoForApiVersion(ApiVersionDescription description)
{
var info = new Info()
{
Title = $"Grupo Boticário Challenge {description.ApiVersion}",
Version = description.ApiVersion.ToString(),
Description = ".NET Core Rest API with SQLITE, EFCore and Self-Documented with Swagger",
Contact = new Contact()
{
Name = "Grupo Boticário/Emanuel Rocha", Email = ""
},
TermsOfService = "Shareware",
License = new License()
{
Name = "EMANUEL ROCHA V" + Assembly.GetExecutingAssembly().GetName().Version, Url = "https://github.com/ZXVentures/code-challenge/blob/master/backend.md"
}
};
if (description.IsDeprecated)
{
info.Description += " This API version has been deprecated.";
}
return(info);
}
static Info CreateInfoForApiVersion(ApiVersionDescription description)
{
var info = new Info()
{
Title = $"API {description.ApiVersion}",
Version = description.ApiVersion.ToString(),
Description = "An application with Swagger, Swashbuckle, and API versioning.",
Contact = new Contact()
{
Name = "VND", Email = "*****@*****.**"
},
TermsOfService = "Shareware",
License = new License()
{
Name = "MIT", Url = "https://opensource.org/licenses/MIT"
}
};
if (description.IsDeprecated)
{
info.Description += " This API version has been deprecated.";
}
return(info);
}
private static Info CreateInfoForApiVersion(ApiVersionDescription description)
{
var info = new Info()
{
Title = "FermataFish API " + description.ApiVersion,
Version = description.ApiVersion.ToString(),
Description = "Visit https://generator.swagger.io/ to generate a client for this API",
Contact = new Contact()
{
Name = "test", Email = "*****@*****.**"
},
TermsOfService = string.Empty,
License = new License()
{
Name = "MIT", Url = "https://opensource.org/licenses/MIT"
}
};
if (description.IsDeprecated)
{
info.Description += " This API version has been deprecated.";
}
return(info);
}
private static OpenApiInfo CreateInfoForApiVersion(ApiVersionDescription description)
=> new OpenApiInfo
{
Title = Constantes.NOME_API,
Version = description.ApiVersion.ToString(),
Description = Constantes.DESCRICAO_API
};
private static Info CreateInfoForApiVersion(ApiVersionDescription description)
{
var info = new Info()
{
Title = $"Account service API {description.ApiVersion}",
Version = description.ApiVersion.ToString(),
Description = "Swagger (OpenAPI) definition for [project/service name]",
Contact = new Contact()
{
Name = "[Contact name]", Email = "[Contact e-mail]"
},
TermsOfService = "Shareware",
License = new License()
{
Name = "MIT", Url = "https://opensource.org/licenses/MIT"
}
};
if (description.IsDeprecated)
{
info.Description += " This API version has been deprecated.";
}
return(info);
}
private Info CreateInfoForApiVersion(ApiVersionDescription description)
{
var info = new Info()
{
Title = $"AuditLog.co API {description.ApiVersion}",
Version = description.ApiVersion.ToString(),
Description = "API for AuditLog.co",
Contact = new Contact()
{
Name = "Eli Weinstock-Herman", Email = "*****@*****.**"
},
//TermsOfService = "Shareware",
License = new License()
{
Name = "Commercial"
}
};
if (description.IsDeprecated)
{
info.Description += " This API version has been deprecated.";
}
return(info);
}
private OpenApiInfo CreateInfoForApiVersion(ApiVersionDescription description)
{
var openApiInfo = new OpenApiInfo()
{
Title = "API - ihtech.io",
Version = description.ApiVersion.ToString(),
Description = "Esta API faz parte do curso REST AspNet Core com WebApi",
Contact = new OpenApiContact()
{
Name = "Icaro Henrique", Email = "*****@*****.**"
},
TermsOfService = new System.Uri("https://opensource.org/licenses/MIT"),
License = new OpenApiLicense()
{
Name = "MIT", Url = new System.Uri("https://opensource.org/licenses/MIT")
}
};
if (description.IsDeprecated)
{
openApiInfo.Description += "Esta versão está obsoleta!";
}
return(openApiInfo);
}
static Info CreateInfoForApiVersion(ApiVersionDescription description)
{
var info = new Info()
{
Title = $"Static Analysis - Public API {description.ApiVersion}",
Version = description.ApiVersion.ToString(),
Description = "Open API Specification",
Contact = new Contact()
{
Name = "Renato Heeb", Email = "*****@*****.**"
},
TermsOfService = "public domain",
License = new License()
{
Name = "MIT License", Url = "https://opensource.org/licenses/MIT"
}
};
if (description.IsDeprecated)
{
info.Description += " This API version has been deprecated.";
}
return(info);
}
static Info CreateInfoForApiVersion(ApiVersionDescription description)
{
var info = new Info()
{
Title = $"Sample API {description.ApiVersion}",
Version = description.ApiVersion.ToString(),
Description = "A sample application with Swagger, Swashbuckle, and API versioning.",
Contact = new Contact()
{
Name = "Phil Japikse", Email = "*****@*****.**"
},
TermsOfService = "Shareware",
License = new License()
{
Name = "MIT", Url = "https://opensource.org/licenses/MIT"
}
};
if (description.IsDeprecated)
{
info.Description += " This API version has been deprecated.";
}
return(info);
}
static Info CreateInfoForApiVersion(ApiVersionDescription description)
{
var info = new Info()
{
Title = $"Valkyrie Industries API {description.ApiVersion}",
Version = description.ApiVersion.ToString(),
Description = "Playground for CQRS and Event Sourcing",
Contact = new Contact()
{
Name = "Chris Gundersen", Email = "*****@*****.**"
},
TermsOfService = "Shareware",
License = new License()
{
Name = "MIT", Url = "https://opensource.org/licenses/MIT"
}
};
if (description.IsDeprecated)
{
info.Description += " This API version has been deprecated.";
}
return(info);
}
private static void ConfigureVersionedDescription(
SwaggerGenOptions options,
ApiVersionDescription apiVersion)
{
var dictionairy = new Dictionary <string, string>
{
{ "1.0", "This API features several endpoints showing different API features for API version V1" },
{ "2.0", "This API features several endpoints showing different API features for API version V2" }
};
var apiVersionName = apiVersion.ApiVersion.ToString();
options.SwaggerDoc(apiVersion.GroupName,
new Info()
{
Title = "Clean Architecture Manga",
Contact = new Contact()
{
Name = "@ivanpaulovich",
Email = "*****@*****.**",
Url = "https://github.com/ivanpaulovich"
},
License = new License()
{
Name = "Apache License"
},
Version = apiVersionName,
Description = dictionairy[apiVersionName]
});
}
/// <summary>
/// Adds general API info for the ApiVersionExplorer.
/// </summary>
/// <param name="description">The ApiVersionDescription of the API.</param>
/// <returns>An info object with the relevant info for this API.</returns>
private static OpenApiInfo CreateInfoForApiVersion(ApiVersionDescription description)
{
var info = new OpenApiInfo
{
Version = $"{VersionHelper.GetFileVersionForType(typeof(Startup))} rev.{description.ApiVersion.ToString()}",
Title = "HealthyGamerPortal API",
Description = "A simple example ASP.NET Core Web API",
TermsOfService = new Uri("https://example.com/terms"),
Contact = new OpenApiContact
{
Name = "Shayne Boyer",
Email = string.Empty,
Url = new Uri("https://twitter.com/spboyer"),
},
License = new OpenApiLicense
{
Name = "Use under LICX",
Url = new Uri("https://example.com/license"),
}
};
if (description.IsDeprecated)
{
info.Description += " This API version has been deprecated.";
}
return(info);
}
private static Info CreateInfoForApiVersion(ApiVersionDescription description)
{
var info = new Info
{
Title = $"Board Games API {description.GroupName}",
Version = description.GroupName,
Description = "A sample API for presentation purpose",
TermsOfService = "Do whatever you like with it",
Contact = new Contact
{
Name = "Miroslav Popovic",
Url = "https://miroslavpopovic.com"
},
License = new License
{
Name = "MIT",
Url = "https://opensource.org/licenses/MIT"
}
};
if (description.IsDeprecated)
{
info.Description += " This API version has been deprecated.";
}
return(info);
}
private static Info CreateInfoForApiVersion(ApiVersionDescription description)
{
var info = new Info
{
Title = $"API {description.ApiVersion}",
Version = description.ApiVersion.ToString(),
Description = "API version",
Contact = new Contact()
{
Name = "D. D.", Email = "*****@*****.**"
},
TermsOfService = "Shareware",
License = new License()
{
Name = "MIT", Url = "https://opensource.org/licenses/MIT"
}
};
if (description.IsDeprecated)
{
info.Description += " This API version has been deprecated.";
}
return(info);
}
private static OpenApiInfo CreateInfoForApiVersion(ApiVersionDescription description)
{
OpenApiInfo info = new()
{
Title = "Clean Architecture KPMG",
Version = description.ApiVersion.ToString(),
Description = "",
Contact = new OpenApiContact {
Name = "nome aqui", Email = "email@aqui"
},
TermsOfService = new Uri(UriString),
License = new OpenApiLicense
{
Name = "Apache License",
Url = new Uri(
UriString1)
}
};
if (description.IsDeprecated)
{
info.Description += " This API version has been deprecated.";
}
return(info);
}
}
private static Info CreateInfoForApiVersion(ApiVersionDescription description)
{
var info = new Info()
{
Title = $"Simple API {description.ApiVersion}",
Version = description.ApiVersion.ToString(),
Description = "A simple API with versioning and services.",
Contact = new Contact()
{
Name = "Richárd Gyikó", Email = "*****@*****.**"
},
TermsOfService = "Shareware",
License = new License()
{
Name = "MIT", Url = "https://opensource.org/licenses/MIT"
}
};
if (description.IsDeprecated)
{
info.Description += " This API version has been deprecated.";
}
return(info);
}
private Info CreateInfoForApiVersion(ApiVersionDescription description)
{
var apiInformation = new Info()
{
Contact = new Contact()
{
Email = "*****@*****.**"
},
Version = description.ApiVersion.ToString(),
Title = $"Swagger sample versioninig {description.ApiVersion}",
Description = "A sample application using Swagger & Api Versioning",
TermsOfService = "bla bla bla",
License = new License()
{
Name = "MIT", Url = "https://opensource.org/licenses/MIT"
}
};
if (description.IsDeprecated)
{
apiInformation.Description += " THIS API VERSION HAS BEEN DEPRECATED";
}
return(apiInformation);
}
/// <summary>
/// Internal implementation for building the Swagger basic config.
/// </summary>
/// <param name="description">The description object containing the.</param>
/// <param name="apiInfo"></param>
/// <returns>The generated Open API info.</returns>
private static OpenApiInfo CreateInfoForApiVersion(ApiVersionDescription description,
ApiInfoOptions apiInfo)
{
var info = new OpenApiInfo
{
Title = apiInfo.Title,
Version = description.ApiVersion.ToString(),
Description = apiInfo.Description,
TermsOfService = new Uri(apiInfo.TermsOfService),
Contact = new OpenApiContact
{
Name = apiInfo.Contact.Name,
Email = apiInfo.Contact.Email,
Url = new Uri(apiInfo.Contact.Url)
},
License = new OpenApiLicense
{
Name = apiInfo.License.Name
}
};
if (description.IsDeprecated)
{
info.Description += @"<p><strong><span style=""color:white;background-color:red"">VERSION IS DEPRECATED</span></strong></p>";
}
return(info);
}
private static Info CreateSwaggerInfoForApiVersion(ApiVersionDescription description, ApiMetaData apiMetaData)
{
var info = new Info()
{
Title = apiMetaData.Name,
Description = apiMetaData.Description,
Version = description.ApiVersion.ToString()
};
if (info.Version.Equals("1.0"))
{
info.Description += "<br>Initial version.";
}
else
{
var versionDescription = apiMetaData.VersionIngDescriptions?[info.Version];
if (!string.IsNullOrWhiteSpace(versionDescription))
{
info.Description += $"<br>{versionDescription}";
}
}
if (description.IsDeprecated)
{
info.Description += "<br><br><span style=\"color: #ff0000;font-weight: bold;\">This version is already deprecated.</span>";
}
return(info);
}
private static OpenApiInfo CreateInfoForApiVersion(ApiVersionDescription description)
{
var info = new OpenApiInfo()
{
Title = "Blockcore Node API",
Version = description.ApiVersion.ToString(),
Description = "Access to the Blockcore Node features.",
Contact = new OpenApiContact
{
Name = "Blockcore",
Url = new Uri("https://www.blockcore.net/")
}
};
if (info.Version.Contains("dev"))
{
info.Description += " This version of the API is in development and subject to change. Use an earlier version for production applications.";
}
if (description.IsDeprecated)
{
info.Description += " This API version has been deprecated.";
}
return(info);
}
public static Info CreateInfoForApiVersion(IConfiguration config, ApiVersionDescription description)
{
var info = new Info()
{
Title = $"{config.GetValue("OpenApi:Title", "API")} {description.ApiVersion}",
Version = description.ApiVersion.ToString(),
Description = config.GetValue("OpenApi:Description", "An application with Swagger, Swashbuckle, and API versioning."),
Contact = new Contact()
{
Name = config.GetValue("OpenApi:ContactName", "Vietnam Devs"),
Email = config.GetValue("OpenApi:ContactEmail", "*****@*****.**")
},
TermsOfService = config.GetValue("OpenApi:TermOfService", "Shareware"),
License = new License()
{
Name = config.GetValue("OpenApi:LicenseName", "MIT"),
Url = config.GetValue("OpenApi:LicenseUrl", "https://opensource.org/licenses/MIT")
}
};
if (description.IsDeprecated)
{
info.Description += " This API version has been deprecated.";
}
return(info);
}
public static Info CreateInfoForApiVersion(ApiVersionDescription description)
{
var info = new Info()
{
Title = $"API {description.ApiVersion}",
Version = description.ApiVersion.ToString(),
Description = "My test project",
Contact = new Contact()
{
Name = "rour", Email = "*****@*****.**"
},
//TermsOfService = "Demo",
License = new License()
{
Name = "GPL-3.0", Url = "https://opensource.org/licenses/GPL-3.0"
}
};
if (description.IsDeprecated)
{
info.Description += " This API version has been deprecated.";
}
return(info);
}
private static Info CreateInfoForApiVersion(ApiVersionDescription description)
{
var info = new Info()
{
Title = $"FFive.io API () {description.ApiVersion}",
Version = description.ApiVersion.ToString(),
Description = "FFive.io Web API",
Contact = new Contact()
{
Name = "Kannan K R", Email = "*****@*****.**"
},
TermsOfService = "http://ffive.io/terms-of-service/",
License = new License()
{
Name = "MIT", Url = "https://opensource.org/licenses/MIT"
}
};
if (description.IsDeprecated)
{
info.Description += " This API version has been deprecated.";
}
return(info);
}
static Info CreateInfoForApiVersion(ApiVersionDescription description)
{
var info = new Info()
{
Title = "Exemplo de Versionamento de API",
Version = description.ApiVersion.ToString(),
Description = "Essa aplicação apresenta como Exemplo, saida em format Xml,versionamento de API com Swagger, Swashbuckle, e API versioning.",
Contact = new Contact()
{
Name = "Nick Fury", Email = "*****@*****.**"
},
TermsOfService = "Shareware",
License = new License()
{
Name = "MIT", Url = "https://opensource.org/licenses/MIT"
}
};
if (description.IsDeprecated)
{
info.Description += " This API version has been deprecated.";
}
return(info);
}
static Info CreateInfoForApiVersion(ApiVersionDescription description)
{
var info = new Info()
{
Title = $"Salesforce Outbound API {description.ApiVersion}",
Version = description.ApiVersion.ToString(),
Description = "Salesforce integration with Swagger, Swashbuckle, Input Formatting and API versioning.",
Contact = new Contact()
{
Name = "Joe Walters", Email = "*****@*****.**"
},
TermsOfService = "Owned By TNDStudios",
License = new License()
{
Name = "MIT", Url = "https://opensource.org/licenses/MIT"
}
};
if (description.IsDeprecated)
{
info.Description += " <b color=\"red\">This API version has been deprecated</b>.";
}
return(info);
}
static Info CreateInfoForApiVersion(ApiVersionDescription description)
{
var info = new Info()
{
Title = $"Sample API {description.ApiVersion}",
Version = description.ApiVersion.ToString(),
Description = "Manga api service.",
Contact = new Contact()
{
Name = "Michael Connelly", Email = "*****@*****.**"
},
TermsOfService = "Shareware",
License = new License()
{
Name = "MIT", Url = "https://opensource.org/licenses/MIT"
}
};
if (description.IsDeprecated)
{
info.Description += " This API version has been deprecated.";
}
return(info);
}
static OpenApiInfo CreateInfoForApiVersion(ApiVersionDescription description)
{
var info = new OpenApiInfo()
{
Title = $"CalculatorApi {description.ApiVersion}",
Version = description.ApiVersion.ToString(),
Description = "CalculatorApi",
Contact = new OpenApiContact()
{
Name = "Iain Kiloh", Email = "*****@*****.**"
},
TermsOfService = new System.Uri("https://kilohsoftware.com"),
License = new OpenApiLicense()
{
Name = "None", Url = new System.Uri("https://kilohsoftware.com")
}
};
if (description.IsDeprecated)
{
info.Description += " This API version has been deprecated.";
}
return(info);
}
static Info CreateInfoForApiVersion(ApiVersionDescription description, IConfiguration Configuration)
{
var _appName = typeof(Startup).GetTypeInfo().Assembly.GetName().Name;
var info = new Info()
{
Title = $"{_appName} API {description.ApiVersion}",
Version = description.ApiVersion.ToString(),
Description = "TODO",
Contact = new Contact()
{
Name = Configuration.GetSection("About")["AuthorName"],
Email = Configuration.GetSection("About")["AuthorEmail"],
Url = Configuration.GetSection("About")["AuthorUrl"]
},
TermsOfService = _appName,
License = new License()
{
Name = Configuration.GetSection("About")["LicenseName"],
Url = Configuration.GetSection("About")["LicenseUrl"]
}
};
if (description.IsDeprecated)
{
info.Description += " This API version has been deprecated.";
}
return(info);
}
