luoyunchong / igeekfan.aspnetcore.knife4jui Goto Github PK

EndpointRoutingMiddleware matches endpoints setup by EndpointMiddleware and so must be added to the request execution pipeline before EndpointMiddleware. Please add EndpointRoutingMiddleware by calling 'IApplicationBuilder.UseRouting' inside the call to 'Configure(...)' in the application startup code.

当前 FastEndpoints.Swagger 的 nuget 包是基于 NSwag.AspNetCore 的，目前 FastEndpoints 框架的提供者不考虑支持 Swashbuckle.AspNetCore.Swagger 这个包集成 FastEndpoints.Swagger 的支持，请问 IGeekFan.AspNetCore.Knife4jUI 可以提供对 FastEndpoints 框架的支持么？

• FastEndpoints：https://fast-endpoints.com/

可否开放前端页面的ajax超时时间配置，项目请求数据比较大，超过20s了，前端直接超时

When will .net6 be supported?

子类的属性参数说明没有显示出来，但是如果是List<子类>的属性，参数说明又能显示，这是什么原因呢？

请问如何配置才能实现登录查看接口，我看swagger-ui-boot是有这个功能的，不知道这个版本是否支持这个功能？

post请求方式下不支持url 中 query传参吗

入参中，参数的描述显示的是枚举的定义，而不是参数的定义
出参中，参数的描述是空的，应该要显示参数的定义

我使用最新的IGeekFan.AspNetCore.Knife4JUI(0.0.8)，运行起来后，返回值依然是下载文件呢？我看你关闭的issue中说升级到0.0.2版本就已经解决了这个问题呢？还有就是咱们这个包还在一直更新吗？看最新版本还是2020年10月23日发布的

开启缓存已打开的api文档

开启分组tag显示description说明属性

这两个选项在0.0.9版本里面没法看到 了 被两道下划线给覆盖
不知道能否解决下呢 谢谢了

在 FastEndpoint 框架中使用 Knife4jUI 和 FastEndpoints.Swagger 的对比。

先定义 4 个 Endpoint ，分别如下：

- MyEndpoint : Endpoint<MyRequest, MyResponse>
- TheyEndpoint : Endpoint<UserRequest<TheyReqDto>, UserResponse<TheyInfo>>
- UserEndpoint : Endpoint<UserRequest<UserReqDto>, UserResponse<UserInfo>>
- YourEndpoint : Endpoint<YourRequest<YourReqDto>, YourResponse<YourInfo>>

• MyEndpoint （get请求）可以正常显示参数说明（来自 DTO 模型 MyRequest 的属性注释）

• TheyEndpoint （get请求）不能正常显示参数说明（来自 DTO 模型 UserRequest<TheyReqDto> 的属性注释）

• UserEndpoint （get请求）也是类似的问题，但是注意和 TheyEndpoint 对比，在 UserEndpoint 中 UserReqDto 属性中还存在 UserFeatures 类型；

• YourEndpoint （post请求）参数说明 "args": {} 也未能正常显示对应的 DTO 模型属性

项目环境配置说明：

<PropertyGroup>
    <TargetFramework>net7.0</TargetFramework>
    <Nullable>enable</Nullable>
    <ImplicitUsings>enable</ImplicitUsings>
    <GenerateDocumentationFile>true</GenerateDocumentationFile>
</PropertyGroup>

注意：把 GenerateDocumentationFile 设置为 false 再对比查看，显示不一样的效果。

说明：AddSwaggerDoc 中设置了 settings.OperationProcessors.Add(new DefaultValueOperationProcessor());

这几个 Endpoint 注意仔细对比，都有对应参照，在原生 Swagger(FastEndpoints.Swagger) 显示相对正常，但是 Knife4jUI 中显示就不太符合预期。

完整 demo 请查看这里 => Solution1.zip

打开swagger会读取/v3/api-docs/swagger-config配置，但是目前是直接从根目录读的，没从当前路由后继续读，我看js里面是/开头的，作者麻烦处理下呢。

我访问地址是 http://127.0.0.1/test/doc

http://127.0.0.1/test 是我项目的网关地址。
doc是swagger地址。

请问如何在api地址前面自定义前缀啊，就是测试时的api url那里

流被解析成了字符串。不能下载文件，swagger的接口调试是支持文件下载的。
我看你这个UI框架和postman很像啊，但是postman是有"Sand and Download"提供下载文件的功能。

The required antiforgery header value "RequestVerificationToken" is not present.

POST 请求会出现该错误，是最近更新了这个吗？

接口请求参数标注为[FromForm]时，界面中的文档请求示例显示不出来，调试中的请求参数也没显示，导致无法传参数进行调试

枚举目前无法正常显示。

是左侧滚动高度计算有误还是什么问题?

我的API需要向IdentityServer验证获取AccessToken后才能调用, 这一点在之前使用原生SwaggerUI时就已经实现, 现在迁移到Knife4jUI, 却发现界面上不再支持认证流程, 请问我是否该弃坑?

public void ConfigureServices(IServiceCollection services)
 {
    // 其它Service
     services.AddOpenApiDocument();
 }

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
            // 其它 Use
          app.UseOpenApi();
          app.UseKnife4UI(c =>
         {
               c.RoutePrefix = "";
               c.SwaggerEndpoint("/swagger/v1/swagger.json");
          });
}

即可使用 Knife4jUI

我配置了如下配置
options.RoutePrefix ="aa"
options.SwaggerEndpoint="/bb/swagger.json"
但是ui访问的url地址不是 /bb/swagger.json 而是 aa/bb/swagger.json

我在.net5中使用该组件，接口的参数描述，dto对象的描述都能正常生成和显示，但最近我在.net6中发现dto的属性描述无法生成处理，请问你们有遇到类似问题吗？

如图：

有时候，通过Nginx分路径转发不同API情况下，有必须用到 RoutePrefix ，但 swagger-resources 加前缀后访问不到，404报错。
查看源码得知：Knife4jUIMiddleware.cs 文件第69行，if (httpMethod == "GET" && Regex.IsMatch(path, $"^/swagger-resources$")) 改为 if (httpMethod == "GET" && Regex.IsMatch(path, $"/swagger-resources$"))，即可。这样的话，加了前缀的 swagger-resources 也可被请求到。
优化一下，方便其它人。
就这个小地方，我花了几个小时，尝试不行，不得已才查看源码找到的。
谢谢楼主的无私开源贡献！！！

根据README.md文档更改原始项目并未执行成功
接口 swagger-config 404
根据示例项目成功 希望更改下文档

我想针对不同的接口隐藏一些属性，目前我在原来的Swashbuckle.AspNetCore.SwaggerGen中只能实现在实体中特性标记删除，而不能在接口上实现

设置了RoutePrefix访问就会报错，加载不出接口文档

我在UI中集成了两个api地址，第一个是/，第二个是/v2。但是调用v2的api时请求的还是/。
并且添加服务地址的在ui中也没体现
c.AddServer(new OpenApiServer()
{
Url = "url1",
Description = "vvv"
});

示例项目：AspNetCore6Api
返回内容：显示文件

我弄了个测试仓库, 你可以试一下
https://github.com/MoondanceZ/Knife4jUiTest.git

swagger ui

knife4jui

code

您好，作者，我和大部分其他人早已经发现，默认的丝袜哥ui界面不够现代化，且没法保存上一次的编辑记录，关于调试接口与授权每一次都没重新输入，确实需要一个更完美的ui了！！！
我们是从早期版本开始使用的，操作起来确实方便了不少，对于目前现状，我认为有很大的意义！
不过目前存在一下两点不足：（我们这块反应的人也挺多的）

关于鉴权：

好像是无效的，我们只能通过全局配置进行添加

关于显示：

在0.0.11v添加了控制器显示，很舒服，但是：
当有注释存在的情况下，无法让菜单显示的是接口名

如果没有注释或者为空注释：

有的时候，应该让接口名显示，后跟注释

最后，感谢作者让我们的API文档接口与java齐平~~~

/v3/api-docs/swagger-config

因为搜索框在右边，结果在最左边，这样很别扭。。。

在构建MiniProfiler中根据IGeekFan.AspNetCore.Knife4jUI项目中的代码替换index.html后，在加上MiniProfiler的js后，发现一个问题
Knife4jUI中的调试等功能丢失
请问作者index.html页面要怎么替换，下面是我代码的截图

用的是：NSwag
全局这样加的

builder.Services.AddOpenApiDocument(c =>
{
    c.UseControllerSummaryAsTagDescription = true;

    c.AddSecurity("client", new OpenApiSecurityScheme
    {
        Description = "client for request",
        Name = "client",
        In = OpenApiSecurityApiKeyLocation.Header,
        Type = OpenApiSecuritySchemeType.ApiKey
    });

    c.AddSecurity("apiKey", Enumerable.Empty<string>(), new OpenApiSecurityScheme
    {
        Description = "Authorization for request",
        Name = "Authorization",
        In = OpenApiSecurityApiKeyLocation.Header,
        Type = OpenApiSecuritySchemeType.ApiKey
    });

    c.UseHttpAttributeNameAsOperationId = true;
    c.UseRouteNameAsOperationId = true;

});

Json数据是正常的

接口很多(达到700以上)，文档刷新不出来

• 该项目基于此项目打包

• https://gitee.com/igeekfan/knife4j/tree/igeekfan-dev/knife4j-vue-v3