Kitpymes.Core.Api

📋 Requerimientos

🔧 Instalación

Install-Package Kitpymes.Core.Api

dotnet add package Kitpymes.Core.Api

⌨️ Código

ApiVersioning

publicstaticclassApiVersioningApplicationBuilderExtensions{publicstaticIApplicationBuilderLoadApiVersioning(thisIApplicationBuilderapplication){}}

publicstaticclassApiVersioningServiceCollectionExtensions{publicstaticIServiceCollectionLoadApiVersioning(thisIServiceCollectionservices,IConfigurationconfiguration,IApiVersionReader?apiVersionReader=null,IApiVersionConventionBuilder?conventions=null){}publicstaticIServiceCollectionLoadApiVersioning(thisIServiceCollectionservices,Action<ApiVersioningOptions>options){}publicstaticIServiceCollectionLoadApiVersioning(thisIServiceCollectionservices,ApiVersioningSettingssettings){}}

publicclassApiVersioningOptions{publicApiVersioningOptionsWithEnabled(boolenabled){}publicApiVersioningOptionsWithMajorVersion(intversion){}publicApiVersioningOptionsWithMinorVersion(intversion){}publicApiVersioningOptionsWithAssumeDefaultVersionWhenUnspecified(boolassume){}publicApiVersioningOptionsWithReportApiVersions(boolreport){}publicApiVersioningOptionsWithSubstituteApiVersionInUrl(boolsubstitute){}publicApiVersioningOptionsWithGroupNameFormat(stringnameFormat){}publicApiVersioningOptionsWithApiVersionReader(IApiVersionReaderapiVersionReader){}publicApiVersioningOptionsWithConventions(IApiVersionConventionBuilderconventions){}}

publicclassApiVersioningSettings{publicbool?Enabled{get;set;}publicint?MajorVersion{get;set;}publicint?MinorVersion{get;set;}publicbool?AssumeDefaultVersionWhenUnspecified{get;set;}publicbool?ReportApiVersions{get;set;}publicbool?SubstituteApiVersionInUrl{get;set;}publicstring?GroupNameFormat{get;set;}[JsonIgnore]publicIApiVersionReader?ApiVersionReader{get;set;}[JsonIgnore]publicIApiVersionConventionBuilder?Conventions{get;set;}}

publicenumApiVersioningStatus{Alpha,Beta,RC,Stable,}

AppSession

publicstaticclassDependencyInjectionSession{publicstaticIServiceCollectionLoadSession(thisIServiceCollectionservices,Action<SessionOptions>options){}publicstaticIServiceCollectionLoadSession(thisIServiceCollectionservices){}publicstaticIApplicationBuilderLoadSession(thisIApplicationBuilderapplication){}}

publicclassSessionOptions{publicSessionOptionsWithEnabled(boolenabled=true){}publicSessionOptionsWithMultitenancy(boolenabled=true){}publicSessionOptionsWithTenants(paramsEntities.TenantSession[]tenants){}}

publicclassSessionSettings{publicbool?Enabled{get;set;}publicbool?IsMultitenancy{get;set;}publicList<TenantSession>Tenants{get;set;}=new();}

Host

publicstaticclassInitHost{publicstaticasyncTaskRunAsync<TStartup>(string[]args)whereTStartup:class{}publicstaticIHostBuild<TStartup>(string[]args)whereTStartup:class{}publicstaticIHostBuilderCustom<TStartup>(string[]args)whereTStartup:class{}}

Result

publicclassAspNetResult:IActionResult{publicAspNetResult(IResultresult)=>Result=result;privateIResultResult{get;}publicasyncTaskExecuteResultAsync(ActionContextcontext){}}

Spa

publicstaticclassSpaApplicationBuilderExtensions{publicstaticIApplicationBuilderLoadSpa(thisIApplicationBuilderapplication,Action<AngularOptions>options){}publicstaticIApplicationBuilderLoadSpa(thisIApplicationBuilderapplication,AngularSettingssettings){}}

publicstaticclassSpaServiceCollectionExtensions{publicstaticIServiceCollectionLoadSpa(thisIServiceCollectionservices,stringrootPath=DefaultRootPath){}}

publicabstractclassSpaBaseSettings{publicbool?{get;set;}publicstring?SourcePath{get;set;}publicstring?NpmScript{get;set;}publicstring?BaseUri{get;set;}}

publicclassSpaOptions{publicSpaOptionsWithEnabled(boolenabled=true){}publicSpaOptionsWithAngular(Action<AngularOptions>options){}publicSpaOptionsWithAngular(AngularSettingssettings){}}

publicclassSpaSettings{publicbool?Enabled{get;set;}publicAngularSettings?AngularSettings{get;set;}}

publicclassAngularOptions{publicAngularOptionsWithEnabled(boolenabled=true){}publicAngularOptionsWithSourcePath(stringsourcePath=AngularSettings.DefaultSourcePath){}publicAngularOptionsWithNpmScript(stringnpmScript=AngularSettings.DefaultNpmScript){}publicAngularOptionsWithBaseUri(stringbaseUri=AngularSettings.DefaultBaseUri){}}

publicclassAngularSettings:SpaBaseSettings{}

Swagger

publicstaticclassSwaggerApplicationBuilderExtensions{publicstaticIApplicationBuilderLoadSwagger(thisIApplicationBuilderapplication){}}

publicstaticclassSwaggerOperationFilterContextExtensions{publicstaticIEnumerable<TAttribute>GetControllerAndActionAttributes<TAttribute>(thisOperationFilterContextcontext)whereTAttribute:Attribute{}}

publicstaticclassSwaggerServiceCollectionExtensions{publicstaticIServiceCollectionLoadSwagger(thisIServiceCollectionservices,Action<SwaggerOptions>options){}publicstaticIServiceCollectionLoadSwagger(thisIServiceCollectionservices,SwaggerSettingssettings){}}

publicclassApiExplorerDocumentFilter:IDocumentFilter{publicApiExplorerDocumentFilter(IOptions<ApiExplorerOptions>options){}publicvoidApply(OpenApiDocumentswaggerDoc,DocumentFilterContextcontext){}}

publicclassAuthorizationBearerFilter:IOperationFilter{publicvoidApply(OpenApiOperationoperation,OperationFilterContextcontext){}}

publicsealedclassDefaultValuesFilter:IOperationFilter{publicvoidApply(OpenApiOperationoperation,OperationFilterContextcontext){}}

publicsealedclassStatusCodesFilter:IOperationFilter{publicvoidApply(OpenApiOperationoperation,OperationFilterContextcontext){}}

publicsealedclassSupportedLanguagesFilter:IOperationFilter{publicSupportedLanguagesFilter(IServiceProviderserviceProvider){}publicvoidApply(OpenApiOperationoperation,OperationFilterContextcontext){}}

publicsealedclassYamlDocumentFilter:IDocumentFilter{privateIWebHostEnvironmentHostingEnvironment{get;}publicYamlDocumentFilter(IWebHostEnvironmenthostingEnvironment){}publicvoidApply(OpenApiDocumentswaggerDoc,DocumentFilterContextcontext){}}

publicclassContactSettings{publicstring?Name{get;set;}publicstring?Url{get;set;}publicstring?Email{get;set;}}

publicclassLicenseSettings{publicstring?Name{get;set;}publicstring?Url{get;set;}}

publicclassSecuritySettings{publicstring?Title{get;set;}publicstring?Name{get;set;}publicstring?Scheme{get;set;}publicstring?Description{get;set;}publicint?ParameterLocation{get;set;}publicint?SecurityType{get;set;}}

publicclassSwaggerOptions{publicSwaggerOptionsWithEnabled(boolenabled=true){}publicSwaggerOptionsWithRoutePrefix(stringroutePrefix){}publicSwaggerOptionsWithVersion(stringversion){}publicSwaggerOptionsWithTitle(stringtitle){}publicSwaggerOptionsWithDescription(stringdescription){}publicSwaggerOptionsWithTermsOfServiceUrl(stringurl){}publicSwaggerOptionsWithContact(ContactSettingscontact){}publicSwaggerOptionsWithLicense(LicenseSettingslicense){}publicSwaggerOptionsWithSecurity(SecuritySettingssecurity){}publicSwaggerOptionsWithXmlComments(Assemblyassembly){}}

publicclassSwaggerSettings{publicbool?Enabled{get;set;}publicstring?RoutePrefix{get;set;}publicstring?Version{get;set;}publicstring?Title{get;set;}publicstring?Description{get;set;}publicstring?TermsOfServiceUrl{get;set;}publicContactSettingsContact{get;set;}=newContactSettings();publicLicenseSettingsLicense{get;set;}=newLicenseSettings();publicSecuritySettingsSecurity{get;set;}=newSecuritySettings();publicAssembly?XmlComments{get;set;}[JsonIgnore]publicstringRoutePrefixWithSlash=>string.IsNullOrWhiteSpace(RoutePrefix)?string.Empty:RoutePrefix+"/";}

🛠️ Construido con

✒️ Autores

📄 Licencia

🎁 Gratitud