Microsoft.Restier.AspNetCore.Swagger 1.1.1

Microsoft Restier - 简单的OData

发布   |   文档   |   OData v4.01 文档

Restier ASP.NET Core的Swagger

此包可以帮助您在代码几行内快速实现Restier服务中的OpenAPI的Swagger.json和Swagger UI。

支持的平台

Microsoft.Restier.AspNetCore.Swagger 1.1目前支持以下平台

• ASP.NET Core 6.0, 7.0, 和 8.0 通过端点路由

入门指南

将OpenAPI集成到您的Restier项目中很简单！

步骤 1: 安装 Microsoft.Restier.AspNetCore.Swagger

• 将上述包添加到您的API项目中。
• [可选] 将您的Restier包的版本更改为 1.*-*，以便始终获取最新版本。

步骤 2: 转换到端点路由（第1部分）

• 将新参数添加到您的 services.AddRestier() 调用的末尾

    services.AddRestier((builder) =>
    {
        ...
    }, true); // <-- @robertmclaws: This parameter adds Endpoint Routing support.

步骤 3: 注册Swagger服务

• 在调用services.AddRestier()之后立即添加以下行

services.AddRestierSwagger();

• 此方法有一个重载版本，它接受一个Action<OpenApiConvertSettings>，这允许您更改生成Swagger定义的配置。

步骤 4：转换为端点路由及使用Swagger（第 2 部分）

• 将您现有的Configure代码替换为以下内容（别忘了您的自定义内容）

    public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
    {
        if (env.IsDevelopment())
        {
            app.UseDeveloperExceptionPage();
        }

        app.UseRestierBatching();
        app.UseRouting();

        app.UseAuthorization();
        // @robertmclaws: This line is optional but helps with leveraging ClaimsPrincipal.Current for cross-platform business logic.
        app.UseClaimsPrincipals();

        app.UseEndpoints(endpoints =>
        {
            endpoints.Select().Expand().Filter().OrderBy().MaxTop(100).Count().SetTimeZoneInfo(TimeZoneInfo.Utc);
            endpoints.MapRestier(builder =>
            {
                builder.MapApiRoute<YOURAPITYPEHERE>("ROUTENAME", "ROUTEPREFIX", true);
            });
        });

        app.UseRestierSwagger(true);
    }

• 在最后一行，布尔值指定是否使用SwaggerUI。如果您想控制更多UI配置，请在ConfigureServices()方法中使用services.Configure<SwaggerUIOptions>();。

步骤 5：浏览Swagger资源

• 浏览到/swagger/ROUTENAME/swagger.json以查看生成的Swagger定义。
• 浏览到/swagger以查看Swagger UI。

报告安全问题

安全问题应通过电子邮件私密报告给微软安全响应中心（MSRC）[email protected]。您应在24小时内收到回复。如果由于某种原因您没收到回复，请通过电子邮件跟进，以确保我们收到了您的原始消息。有关更多信息，包括MSRC PGP密钥，请参阅安全技术中心。您也可以在该仓库的SECURITY.md中找到这些说明。

贡献者

特别感谢所有为使Restier成为.NET最好的API开发平台而做出贡献的人。以下人员对该包做出了各自贡献：