Delete Method 404

[naiveZhou]

Version 1.5.2
Hi,i'm using swagger in this framwork.However, it seems that Swagger is not taking effect in this framework . - specifically for the DELETE method.
I’ve confirmed that all other methods work fine. For example, GET and POST are correctly displayed and functional in Swagger — only DELETE isn’t working.
Looking forward to your reply. Thanks!

Controller

public void Register(Router router, HashSet registeredPaths)
{
const string prefix = "/api/files";
registeredPaths.Add(prefix);
router.RegisterFromInstance(this, BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance);
}

[SwaggerApi($"{BasePrefix}/delete/{{id}}", RouteMethod.Delete,
Summary = "",
Description = "",
Tags = new[] { "" })]
private HttpResponse DeleteFile(HttpRequest request)
{
try
{
Console.WriteLine($":::::::::::::::: DeleteFile not work :::::::::::::::::");
return ApiResponse.Ok(null).ToHttpResponse();
}
catch (Exception ex)
{
return ApiResponse.FromException(ex, includeDetails: true).ToHttpResponse();
}
}

Register

public static void RegisterFromInstance(this Router router, object instance,
BindingFlags bindingFlags = BindingFlags.Public | BindingFlags.Instance)
{
Console.WriteLine("RegisterFromInstance router hash: " + router.GetHashCode());

        if (instance == null)
            throw new ArgumentNullException(nameof(instance));

        var instanceType = instance.GetType();

        // 扫描所有带有 SwaggerApiAttribute 的方法
        var methods = instanceType.GetMethods(BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance)
            .Where(m => m.GetCustomAttribute<SwaggerApiAttribute>() != null);

        foreach (var method in methods)
        {
            var attr = method.GetCustomAttribute<SwaggerApiAttribute>();

            // 1. 验证方法签名 (保持不变)
            if (method.ReturnType != typeof(HttpResponse))
            {
                continue;
            }

            var parameters = method.GetParameters();
            if (parameters.Length != 1 || parameters[0].ParameterType != typeof(HttpRequest))
            {
                continue;
            }

            // 2. 路径和方法解析
            string swaggerPath = attr.Path;
            string siskPath = ConvertSwaggerPathToSisk(swaggerPath); // 转换为 :id 格式
            // string siskPath = swaggerPath; // 转换为 :id 格式

            RouteMethod routeMethod;
            try
            {
                // 基于 FileApi.cs 提供的代码，我们假定 attribute.Method 属性是 RouteMethod 类型。
                routeMethod = (RouteMethod)attr.Method;
            }
            catch (InvalidCastException)
            {
                // 如果 attr.Method 是 string (如 "DELETE")，则尝试解析
                if (!Enum.TryParse(attr.Method.ToString(), true, out routeMethod))
                {
                    Console.WriteLine(
                        $"[警告] 方法 {method.Name} 注册失败：无法将 '{attr.Method}' 转换为 Sisk.Core.Routing.RouteMethod。已跳过。");
                    continue;
                }
            }

            // 3. 创建处理函数委托 (RouteAction)
            RouteAction handler = (HttpRequest req) =>
            {
                try
                {
                    return (HttpResponse)method.Invoke(instance, new object[] { req });
                }
                catch (TargetInvocationException ex)
                {
                    Console.WriteLine($"[错误] 处理请求 {swaggerPath} 时发生异常: {ex.InnerException?.Message ?? ex.Message}");
                    return new HttpResponse(System.Net.HttpStatusCode.InternalServerError);
                }
            };

            // 4. BUG FIX: 手动注册 Sisk 路由 (使用 Sisk 兼容的路径和正确的方法)
            Console.WriteLine(
                $"[API注册]方法名：{method.Name} | 路径：{swaggerPath} | Sisk路径：{siskPath} | HTTP方法：{routeMethod}");

            // 使用正确的 HTTP 方法和 Sisk 路径格式进行路由注册
            router.SetRoute(routeMethod, siskPath, handler);
            // 5. BUG FIX: 注册到 Swagger 文档 (使用原始 Swagger 路径和正确的方法)
            SwaggerService.RegisterRoute(
                swaggerPath, // 使用原始的 {id} 路径，确保 Swagger UI 正确提取参数
                routeMethod, // 使用正确的 RouteMethod
                attr.Summary,
                attr.Description,
                attr.Tags,
                attr.Deprecated,
                attr.OperationId
            );
        }
    }

SiskHttpServer

public async void Start()
{
ContextBuilder = ContextBuilder.UseRouter(router =>
{
Console.WriteLine("ContextBuilder Router hash: " + router.GetHashCode());
var fileApi = new FileApi(MUSICPATH);
fileApi.Register(router, RegisteredApiPaths);
if (EnableSwagger)
{
var swaggerService = new SwaggerService(swaggerOptions, router);
// 构建路由前缀：如果 RoutePrefix 为空，则为空字符串；否则为 /{RoutePrefix}
var routePrefix = string.IsNullOrEmpty(swaggerOptions.RoutePrefix) ? "" : $"/{swaggerOptions.RoutePrefix.TrimStart('/')}";

                var swaggerUIPath = string.IsNullOrEmpty(routePrefix) ? "/swagger" : $"{routePrefix}/swagger";
                router.SetRoute(RouteMethod.Get, swaggerUIPath, swaggerService.GetSwaggerUI);
                RegisteredApiPaths.Add(swaggerUIPath);

                var swaggerJsonPath = string.IsNullOrEmpty(routePrefix) ? "/swagger/v1/swagger.json" : $"{routePrefix}/swagger/v1/swagger.json";
                router.SetRoute(RouteMethod.Get, swaggerJsonPath, swaggerService.GetSwaggerJson);
                RegisteredApiPaths.Add(swaggerJsonPath);
            }

            // ========== 第二步：注册业务 API 路由（通过 RouteRules） ==========
            foreach (var action in RouteRules)
            {
                action(router);
            }

            if (EnableWebsite)
            {
                // 先注册根路径路由，确保能访问 "/" 和 "/index.html"
                router.SetRoute(RouteMethod.Get, "/", ServeStaticFiles, null, new IRequestHandler[]
                {
                    new AftereRequestHandler(),
                    new BeforeRequestHandler()
                });

                // 注册通配符路由，处理所有其他路径
                router.SetRoute(RouteMethod.Get, "/{*path}", ServeStaticFiles, null, new IRequestHandler[]
                {
                    new AftereRequestHandler(),
                    new BeforeRequestHandler()
                });
            }
        
        });
        using var host = ContextBuilder.Build();
        await host.StartAsync();
    }

[CypherPotato]

Hello, thanks for the issue.

I couldn't reproduce the problem. The Sisk.HttpServer package doesn't come with a native Swagger mechanism, and I don't know which package you're using for Swagger. Can you provide a reproducible and compilable code for us to investigate better?

On the other hand, there's the Sisk.Documenting package (not yet published, it's under development) that was made to export documentation in Sisk applications. If you're interested, you can help develop this extension.

using Sisk.Core.Entity;
using Sisk.Core.Http;
using Sisk.Core.Routing;
using Sisk.Documenting;
using Sisk.Documenting.Annotations;

using var host = HttpServer.CreateBuilder(5555)
    .UseCors(CrossOriginResourceSharingHeaders.CreatePublicContext())
    .UseApiDocumentation(
        context: new ApiGenerationContext()
        {
            ApplicationName = "My application",
            ApplicationDescription = "It greets someone."
        },
        routerPath: "/api/docs",
        exporter: new OpenApiExporter() { ServerUrls = ["http://localhost:5555/"] })
    .UseRouter(router =>
    {
        router.SetObject(new MyController());
    })
    .Build();

await host.StartAsync();

class MyController
{

    [RouteGet]
    [ApiEndpoint(Description = "Returns a greeting message.")]
    [ApiQueryParameter(name: "name", IsRequired = false, Description = "The name of the person to greet.", Type = "string")]
    public HttpResponse Index(HttpRequest request)
    {
        string? name = request.Query["name"].MaybeNullOrEmpty() ?? "world";
        return new HttpResponse($"Hello, {name}!");
    }
}

[naiveZhou]

Thanks for your response. I made a mistake in my previous statement.
Firstly,i using Swashbuckle Packages in my Project.Secondly, I have attached the sample code I utilized for your reference and review.
And you can run the Main method and then access the address like this: "http://127.0.0.1:9000/swagger". Let me restate the problem:the request returns a 404 error when i use parameters such as "id" id in the method.
SiskWithSwaggerDemo.zip

[CypherPotato]

Found the problem.

In the ConvertSwaggerPathToSisk method in SwaggerRouteExtensions.cs, you convert path expressions to a format compatible with Sisk. The issue is that you rewrite routes /api/files/delete/{id} to /api/files/delete/:id, which is not valid in Sisk. The correct format would be /api/files/delete/<id>.

Note: I also saw that in this method, you rewrite wildcard routes *. Sisk does not support this type of route. You would have to create routes with Regex for that.

private static string ConvertSwaggerPathToSisk(string swaggerPath)
{
    if (string.IsNullOrEmpty(swaggerPath))
        return swaggerPath;

    // rewrite {param} to <param>
    swaggerPath = Regex.Replace(
        swaggerPath,
        @"\{([a-zA-Z0-9_]+)\}",
        @"<$1>"
    );

    return swaggerPath;
}

Link to route path patterns.

[naiveZhou]

Thank you so much for your reply – it’s working now!