Homely.AspNetCore.Mvc.Helpers下載 - Homely.AspNetCore.Mvc.Helpers原始碼下載

Homely - ASP.NET Core MVC 助手

本函式庫包含一系列幫助程式、模型和擴充方法，有助於減少改進 ASP.NET-Core MVC WebApi/RESTful API 的時間和儀式。

樣品/亮點

簡單的 HomeController [HTTP-GET /] 可以顯示橫幅 + 組件/建置資訊。
Json 響應輸出預設帶有一些常見的 JsonSerializerOptions 設定。
自訂 OpenAPI（又稱 Swagger）已連接
簡單、單一的方法即可完成上述所有操作

快速啟動，搞定一切，簡單快速。

這將使用預設設定（如下所列）新增所有項目。簡單、快速、很棒。
添加這兩個。

 public void ConfigureServices(IServiceCollection services)
{
    // - Home controller but no banner.
    // - Default json options: camel casing, no indention, nulls ignored and enums as strings.
    // - OpenApi adeed.
    services.AddControllers()
            .AddDefaultWebApiSettings(); // Can also be totally customized.
}

public void Configure(IApplicationBuilder app)
{
    // - Problem details
    // - OpenAPI
    // - Authorisation
    // - Endpoints (with MapControllers)
    app.UseDefaultWebApiSettings();
}

或更客製化的版本：

 public void ConfigureServices(IServiceCollection services)
{
    // - Home controller but no banner.
    // - Default json options: camel casing, no indention, nulls ignored and enums as strings.
    // - OpenApi adeed.

    var banner = " -- ascii art --";
    var isStackTraceDisplayed = _webHostEnvironment.IsDevelopment();
    var isJsonIndented = _webHostEnvironment.IsDevelopment();
    var jsonDateTimeFormat = "yyyy'-'MM'-'dd'T'HH':'mm':'ssZ" // No milliseconds.
    var openAPITitle = "My API";
    var openAPIVersion = "v1";
    var openAPICustomOperationIdSelector = new Func<ApiDescription, string>((apiDescrption, string) => { .. // refer to sample code in website } );

    services.AddControllers()
            .AddDefaultWebApiSettings(banner,
                                      isStackTraceDisplayed,
                                      isJsonIndented,
                                      jsonDateTimeFormat,
                                      openAPITitle,
                                      openAPIVersion,
                                      openAPICustomOperationIdSelector)
}

public void Configure(IApplicationBuilder app)
{
    // - Problem details
    // - OpenAPI (Customised)
    // - Authorisation
    // - Endpoints (with MapControllers)
    
    var useAuthorizatoin = true;
    var openAPITitle = "My API";
    var openAPIVersion = "v1";
    var openAPIRoutePrefix = "swagger";

    app.UseDefaultWebApiSettings(useAuthorization,
                                 openAPITitle,
                                 openAPIVersion,
                                 openAPIRoutePrefix);
}

否則，您可以挑選您想要的項目。

簡單的 HomeController [HTTP-GET /] 可以顯示橫幅 + 組件/建置資訊。

非常適合 API，這將創建預設的“root/home”路由 => HTTP GET / ：

可選橫幅 - 一些文字（如 ASCII ART）
建構有關程序集的資訊。

 public void ConfigureServices(IServiceCollection services)
{
    var someASCIIArt = "... blah .."; // Optional.

    services.AddControllers()
            .AddAHomeController(services, someASCIIArt);
}

例如輸出

      ___           ___           ___           ___           ___           ___                    ___           ___                 
     /__         /           /           /__         /           /                    /           /            ___   
    /:/  /        /::         /::         /::|  |       /::          :                  /::         /::          /    
   /:/__/        /:/:       /:/:       /:|:|  |      /:/:          :                /:/:       /:/:         :   
  /::   ___   /:/  :     /::~:     /:/|:|  |__   /::~:         /::              /::~:     /::~:        /::__
 /:/:  /__ /:/__/ :__ /:/: :__ /:/ |:| /__ /:/: :__     /:/:__          /:/: :__ /:/: :__  __/://__/
 /__:/:/  / :   /:/  / /_|::/:/  / /__|:|/:/  / :~: /__/    /:/  /__/          /__:/:/  / /__:/:/  / //:/  /   
      ::/  /   :  /:/  /     |:|::/  /      |:/:/  /   : :__     /:/  /                    ::/  /       ::/  /  ::/__/    
      /:/  /     :/:/  /      |:|/__/       |::/  /     : /__/     /__/                     /:/  /         /__/    :__    
     /:/  /       ::/  /       |:|  |         /:/  /       :__                                /:/  /                    /__/    
     /__/         /__/         |__|         /__/         /__/                                /__/                              

                                                                                                      S E R V I C E  ->  A C C O U N T S

Name: ApiGateway.Web
Version: 3.1.0.0
Build Date : Sunday, 7 June 2020 2:41:53 PM
Application Started: Monday, 8 June 2020 12:02:37 PM
Server name: PUREKROME-PC

Json輸出預設使用通用的JsonSerializerSettings。

所有回應均為 JSON，並使用通用 JSON 設定進行格式化：

駝峰命名法屬性名稱。
縮排格式。
忽略具有值的 null 屬性。
枚舉呈現為string的...而不是它們的支援數字值。
可以指定自訂日期時間格式範本。

 // Simplest : i
public void ConfigureServices(IServiceCollection services)
{
    services.AddControllers()
            .AddDefaultJsonOptions();
}

or 

// All options...
public void ConfigureServices(IServiceCollection services)
{
    var isIndented = true;
    string dateTimeFormat = "yyyy'-'MM'-'dd'T'HH':'mm':'ssZ" // No milliseconds.

    services.AddControllers()
            .AddDefaultJsonOptions(isIndented, dateTimeFormat);
}

範例模型/域物件：

 new FakeVehicle
{
    Id = 1,
    Name = "Name1",
    RegistrationNumber = "RegistrationNumber1",
    Colour = ColourType.Grey,
    VIN = null
});

結果 JSON 文字：

 {
  "id": 1,
  "name": "Name1",
  "registrationNumber": "RegistrationNumber1",
  "colour": "Grey"
}

請注意預設的 .NET Core DateTime 格式。
預設情況下，它使用 ISO 8601-1:2019 格式。這意味著如果有幾微秒，那麼它們就會被渲染。如果沒有 -> 則不會渲染任何微秒。這可能會讓某些資料使用者（例如使用 .NET Core API 的 iOS Swift 應用程式）變得困難，因此您可以對特定格式範本進行硬編碼以獲得一致的輸出。

自訂 OpenAPI（又稱 Swagger）已連接

OpenAPI（使用 Swashbuckle 庫）已連接，可讓您定義此 API 的title和version以及自訂route prefix （這對於具有多個 OpenAPI 端點的網關 API 很有用，因為每個微服務都有自己的 OpenAPI 文件）。

 public void ConfigureServices(IServiceCollection services)
{
    services.AddControllers()
            .AddCustomOpenApi("Test API", "v2");
}

public void Configure(IApplicationBuilder app)
{
    app.UseCustomOpenApi("accounts/swagger", "Test API", "v2")
       .UseRouting()
       .UseEndpoints(endpoints => endpoints.MapControllers());
}