Question

我正在使用CMS。所以，当我去'/ painter'时，它被路由到'JobController'。 /管道工也被路由到'JobController'。除了它是MVC而不是WebAPI之外，所以招摇没有发现它，这是可以理解和精细的。

但是我有一个用例，如果我访问/ pianter？json = 1它返回json而不是HTML。

因此，作为API UI，我们希望公开这个“假”端点，这样设计人员就可以看到输出模型。

那么我可以添加一个完全虚假的端点 - 只是为了在设计者和开发人员之间在swagger UI中拥有一个用户界面吗？

除了具有可视UI之外，我们还希望基于openapi标准生成一些TypeScript。

Answer 1

以下是使用IDocumentFilter：

创建带有swashbuckle的Fake端点的选项

    private class DocumentFilterAddFakes : IDocumentFilter
    {
        private PathItem FakePathItem(int i)
        {
            var x = new PathItem();
            x.get = new Operation()
            {
                tags = new[] { "Fake" },
                operationId = "Fake_Get" + i.ToString(),
                consumes = null,
                produces = new[] { "application/json", "text/json", "application/xml", "text/xml" },
                parameters = new List<Parameter>()
                            {
                                new Parameter()
                                {
                                    name = "id",
                                    @in = "path",
                                    required = true,
                                    type = "integer",
                                    format = "int32"
                                }
                            },
            };
            x.get.responses = new Dictionary<string, Response>();
            x.get.responses.Add("200", new Response() { description = "OK", schema = new Schema() { type = "string" } });
            return x;
        }

        public void Apply(SwaggerDocument swaggerDoc, SchemaRegistry schemaRegistry, IApiExplorer apiExplorer)
        {
            for (int i = 0; i < 10; i++)
            {
                swaggerDoc.paths.Add("/Fake/" + i + "/{id}", FakePathItem(i));
            }
        }
    }

这是类似的结果： http://swashbuckletest.azurewebsites.net/swagger/ui/index#/Fake

背后的完整代码在github上： https://github.com/heldersepu/SwashbuckleTest/blob/master/Swagger_Test/App_Start/SwaggerConfig.cs#L316

使用Swashbuckle.Swagger手动添加端点

1 个答案: