{"id":16691510,"url":"https://github.com/bbonkr/kr.bbon.aspnetcore","last_synced_at":"2026-04-13T12:01:46.689Z","repository":{"id":37940591,"uuid":"346203676","full_name":"bbonkr/kr.bbon.AspNetCore","owner":"bbonkr","description":"ASP.NET Core 웹 응용프로그램 프로젝트 (webapi 템플릿 기준)를 시작할 때, 반복적으로 작성하던 사항을 패키지로 정리했습니다.","archived":false,"fork":false,"pushed_at":"2024-03-18T23:39:51.000Z","size":122,"stargazers_count":1,"open_issues_count":3,"forks_count":0,"subscribers_count":1,"default_branch":"dev","last_synced_at":"2025-10-04T17:53:20.794Z","etag":null,"topics":["aspnetcore","dotnet","net5","net6","net7","nuget","webapi"],"latest_commit_sha":null,"homepage":"https://www.nuget.org/packages/kr.bbon.AspNetCore","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bbonkr.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGES.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-03-10T02:12:04.000Z","updated_at":"2024-03-05T11:37:24.000Z","dependencies_parsed_at":"2024-12-18T08:37:51.691Z","dependency_job_id":null,"html_url":"https://github.com/bbonkr/kr.bbon.AspNetCore","commit_stats":null,"previous_names":[],"tags_count":24,"template":false,"template_full_name":null,"purl":"pkg:github/bbonkr/kr.bbon.AspNetCore","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bbonkr%2Fkr.bbon.AspNetCore","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bbonkr%2Fkr.bbon.AspNetCore/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bbonkr%2Fkr.bbon.AspNetCore/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bbonkr%2Fkr.bbon.AspNetCore/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bbonkr","download_url":"https://codeload.github.com/bbonkr/kr.bbon.AspNetCore/tar.gz/refs/heads/dev","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bbonkr%2Fkr.bbon.AspNetCore/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31751705,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-13T09:16:15.125Z","status":"ssl_error","status_checked_at":"2026-04-13T09:16:05.023Z","response_time":93,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aspnetcore","dotnet","net5","net6","net7","nuget","webapi"],"created_at":"2024-10-12T16:08:47.651Z","updated_at":"2026-04-13T12:01:46.657Z","avatar_url":"https://github.com/bbonkr.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# kr.bbon.AspNetCore Package\n\n[![](https://img.shields.io/nuget/v/kr.bbon.AspNetCore)](https://www.nuget.org/packages/kr.bbon.AspNetCore) [![](https://img.shields.io/nuget/dt/kr.bbon.AspNetCore)](https://www.nuget.org/packages/kr.bbon.AspNetCore) [![publish to nuget](https://github.com/bbonkr/kr.bbon.AspNetCore/actions/workflows/build-tag.yaml/badge.svg)](https://github.com/bbonkr/kr.bbon.AspNetCore/actions/workflows/build-tag.yaml)\n\n## 📢 Overview\n\n.NET 5 에서 API 웹 응용프로그램 프로젝트 \u003csmall\u003e(webapi 템플릿 기준)\u003c/small\u003e를 시작할 때, 반복적으로 작성하던 사항을 패키지로 정리했습니다.\n\n\n## 🌈 Namespace\n\n### kr.bbon.AspNetCore\n\n웹 응용프로그램에서 사용되는 기능과 확장 메서드를 포함합니다.\n\n\u003e [kr.bbon.Core](https://www.nuget.org/packages/kr.bbon.Core) 패키지로 이동되었습니다.\n\n### kr.bbon.AspNetCore.Filters\n\nASP.NET Core Mvc Filters를 지원하는 기능을 포함합니다.\n\n### kr.bbon.AspNetCore.Mvc\n\nASP.NET Core MVC를 지원하는 기능을 포함합니다.\n\n## 🎯 Features\n\n### Exception classes\n\n#### HttpStatusException class\n\n\u003e [kr.bbon.Core](https://www.nuget.org/packages/kr.bbon.Core) 패키지로 이동되었습니다.\n\nHTTP 예외를 표현하기 위해 사용됩니다.\n\n\u003e [kr.bbon.Core](https://github.com/bbonkr/kr.bbon.AspNetCore) 패키지로 이전되었습니다.\n\n```csharp\n// Exception handling in action method\ntry\n{\n    // ...\n}\ncatch(HttpStatusException ex)\n{\n    return StatusCode(ex.StatusCode, ex.Message, ex.GetDetails());\n}\ncatch(Exception ex)\n{\n    // ...\n}\n```\n\n#### HttpStatusException\u003cTDeatails\u003e class\n\n\u003e [kr.bbon.Core](https://www.nuget.org/packages/kr.bbon.Core) 패키지로 이동되었습니다.\n\nHTTP 예외와 상세 정보를 표현하기 위해 사용됩니다.\n\n\u003e [kr.bbon.Core](https://github.com/bbonkr/kr.bbon.AspNetCore) 패키지로 이전되었습니다.\n\n```csharp\nthrow new HttpStatusException(HttpStatusCode.BadRequest, new SomeDetails\n{\n    Id = \"err111\",\n    Message = \"AAA 속성의 값이 정수가 아닙니다.\",\n});\n```\n\n#### SomethingWrongException\n\n\u003e [kr.bbon.Core](https://www.nuget.org/packages/kr.bbon.Core) 패키지로 이동되었습니다.\n\n사용자 정의 예외를 표현하기 위해 사용합니다.\n\n\u003e [kr.bbon.Core](https://github.com/bbonkr/kr.bbon.AspNetCore) 패키지로 이전되었습니다.\n\n```csharp\n// Exception handling in action method \ntry\n{\n    // ...\n}\ncatch(SomethingWrongException ex)\n{\n    return StatusCode(HttpStatusCode.Forbidden, ex.Message, ex.GetDetails());\n}\ncatch(Exception ex)\n{\n    // ...\n}\n```\n\n#### SomethingWrongException\u003cTDetails\u003e\n\n\u003e [kr.bbon.Core](https://www.nuget.org/packages/kr.bbon.Core) 패키지로 이동되었습니다.\n\n사용자 정의 예외와 상세 정보를 표현하기 위해 사용합니다.\n\n\u003e [kr.bbon.Core](https://github.com/bbonkr/kr.bbon.AspNetCore) 패키지로 이전되었습니다.\n\n```csharp\nthrow new SomethingWrongException(\"데이터를 처리하지 못했습니다.\", new SomeDetails \n{\n    Id = \"err111\",\n    Message = \"AAA 속성의 값이 정수가 아닙니다.\",\n});\n```\n\n### Extension methods\n\n#### IApplicationBuilder.UseSwaggerUIWithApiVersioning() method\n\nIApplicationBuilder 인터페이스에 UseSwaggerUIWithApiVersioning 메서드를 추가합니다.\n\nSwagger 를 사용하기 위해 필요한 코드 조각이 정리되어 있습니다.\n\n```csharp\n// Configure() on Startup.cs\napp.UseSwaggerUIWithApiVersioning();\n```\n\n#### Object.ToJson\u003cT\u003e() method\n\nObject 클래스에 ToJson 메서드를 추가합니다.\n\n객체의 인스턴스를 JSON 문자열로 직렬화하는 기능을 제공합니다.\n\n\u003e [kr.bbon.Core](https://github.com/bbonkr/kr.bbon.AspNetCore) 패키지로 이전되었습니다.\n\n```csharp\nvar sample = getSampleModel();\nsample.ToJson();\n```\n\nJsonSerializerOptions 매개변수가 지정되지 않은 경우 아래 기본값을 사용합니다.\n\n```csharp\nvar defaultOptions = new JsonSerializerOptions\n{\n    WriteIndented = true,\n    Encoder = JavaScriptEncoder.UnsafeRelaxedJsonEscaping,\n    PropertyNamingPolicy = JsonNamingPolicy.CamelCase,\n};\n```\n\n#### IServiceCollection.AddApiVersioningAndSwaggerGen() method\n\nIServiceCollection 인터페이스에 AddApiVersioningAndSwaggerGen 메서드를 추가합니다.\n\nApiVersioning, Swagger 를 사용하기 위해 필요한 코드조각이 정리되어 있습니다.\n\n\n```csharp\n// ConfigureService() on Startup.cs\nvar defaultApiVersion = new ApiVersion(1, 0);\nservices.Configure\u003cAppOptions\u003e(Configuration.GetSection(AppOptions.Name));\n\nservices.AddApiVersioningAndSwaggerGen(defaultApiVersion);\n```\n\n### Filter classes\n\n#### ApiExceptionHandlerFilter class\n\n컨트롤러에서 처리되지 않은 예외가 발생하면 예외를 처리하는 필터를 제공합니다.\n\n예외 처리 필터를 컨트롤러에서 사용하려면 아래와 같이 클래스 특성으로 추가합니다.\n\n```csharp\n[ApiExceptionHandlerFilter]\n// ...\npublic class SomeController : ApiControllerBase \n{\n    // ...\n}\n```\n\n예외 처리 필터를 액션에서 사용하려면 아래와 같이 클래스 특성으로 추가합니다.\n\n```csharp\n[HttpGet]\n[ApiExceptionHandlerFilter]\npublic IActionResult SomeAction()\n{\n    // ...\n}\n```\n\n예외 처리 필터를 전역으로 사용하려면 아래와 같이 구성합니다.\n\n```csharp\n// ConfigureService() on Startup.cs\nservices.AddControllers(options =\u003e \n{\n    options.Filters.Add\u003cApiExceptionHandlerFilter\u003e();\n});\n```\n\n### Model classes\n\n#### ApiResponseModel classes\n\n동일한 응답을 제공하기 위해 사용되는 응답 모델입니다.\n\n아래와 같은 형식으로 HTTP 응답 본문을 제공합니다.\n\n```\n{\n    statusCode: number\n    message: string\n    instance: string\n    path: string\n    method: string\n    data: T\n}\n```\n\n#### ErrorModel class\n\n사용자 정의 오류를 표현합니다.\n\n\u003e [kr.bbon.Core](https://github.com/bbonkr/kr.bbon.AspNetCore) 패키지로 이전되었습니다.\n\n```csharp\nvar error = new ErrorModel\n{\n    Code = \"Some code\",\n    Message = \"Some message\",\n    InnerError = new ErrorModel\n    {\n        Code = \"Some inner code\",\n        Message = \"Some inner message\",\n    }\n});\n```\n\n### ControllerBase classes\n\n#### ApiControllerBase class\n\n웹 응용프로그램 응답을 동일하게 제공하기 위한 코드조각이 정리되어 있습니다.\n\n\u003e ⚠ ApiControllerBase 클래스를 상속하는 ApiController 는 `ApiVersionAttribute`, `AreaAttribute`, `RouteAttribute` 를 필수적으로 사용해야 합니다.\n\n```csharp\n[ApiVersion(DefaultValues.ApiVersion)]\n[ApiController]\n[Area(DefaultValues.AreaName)]\n[Route(DefaultValues.RouteTemplate)]\n[ApiExceptionHandlerFilter]\npublic class WeatherForecastController : ApiControllerBase \n{\n    // ...\n}\n```\n\n컨트롤러의 액션 메서드에서 아래와 같이 응답을 구성합니다.\n\n```csharp\nvar responseData = GetResponseData();\n\nreturn StatusCode(HttpStatusCode.OK, responseData)\n```\n\nHTTP 응답본문은 아래와 같이 제공됩니다.\n\n```json\n{\n    \"statusCode\": 200,\n    \"message\": null,\n    \"data\": {\n        // ...responseData\n    }\n}\n```\n\n### Etc classes\n\n\u003ca id=\"app-options-class\"\u003e\u003c/a\u003e\n#### AppOptions class\n\n응용 프로그램 구성값을 표현합니다.\n\nappsettings.json 을 아래와 같이 구성하고, 서비스 구성에서 구성값을 읽어서 처리합니다.\n\nOpenApiInfo 클래스도 동일한 값으로 구성됩니다.\n\n```json\n// appsettings.json \n{\n    \"App\": {\n        \"Title\": \"Awesome api\",\n        \"Description\": \"My awesome api !!\"\n    },\n    // ...\n}\n```\n\n```csharp\n// ConfigureService() on Startup.cs\nservices.Configure\u003cAppOptions\u003e(Configuration.GetSection(AppOptions.Name));\n```\n\n\u003ca id=\"configure-swagger-options-base-class\"\u003e\u003c/a\u003e\n#### ConfigureSwaggerOptionsBase class\n\nSwagger 구성값을 위한 기본 클래스입니다.\n\n아래와 같이 `ConfigureSwaggerOptionsBase` 를 상속하는 본인의 `ConfigureSwaggerOptions` 클래스를 정의하세요.\n\n```csharp\npublic class MyConfigureSwaggerOptions :  ConfigureSwaggerOptionsBase {\n    public MyConfigureSwaggerOptions(IApiVersionDescriptionProvider provider, IOptionsMonitor\u003cAppOptions\u003e optionsAccessor)\n        : base(provider) \n    {\n        options = optionsAccessor.CurrentValue;\n    }\n\n    public override string AppTitle =\u003e options.Title;\n\n    public override string AppDescription =\u003e options.Description;\n\n    private readonly AppOptions options;\n}\n```\n\n#### ConfigureSwaggerOptions class\n\n[ConfigureSwaggerOptionsBase](#configure-swagger-options-base-class) 클래스를 구현하는 클래스입니다.\n\n### Constants \n\n#### DefaultValues class\n\nRouteTemplate: \n  클래스 라우트 템플릿의 기본값입니다. `[area]/v{version:apiVersion}/[controller]`\n\nApiVersion:\n  기본 버전 문자열 입니다. `1.0`\n\nAreaName:\n  영역 기본값입니다. `api`","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbbonkr%2Fkr.bbon.aspnetcore","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbbonkr%2Fkr.bbon.aspnetcore","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbbonkr%2Fkr.bbon.aspnetcore/lists"}