当前位置: 首页 > 知识库问答 >
问题:

XML中的Swagger留档不显示查询对象参数的架构

东方涛
2023-03-14

两种情况下生成的 XML 文件相同

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>DateTimeServiceAPI</name>
    </assembly>
    <members>
        <member name="P:DateTimeServiceAPI.DTOs.GetCurrentTimeDTO.TenantId">
            <summary>
            indentifer of the tenant
            </summary>
        </member>
    </members>
</doc>

知道为什么在生成文档时会有这种差异吗?我在搜索此内容时找不到任何相关内容。

如何(强制)将所有数据模型包含在模式部分中?非常感谢任何指针或资源。

谢谢你

共有2个答案

谢灵均
2023-03-14

您应该检查您的GetCurrentTimeDTO模型,用作控制器方法参数的DTO的属性应该设置public,如果它是internalorprivate

public class MyDto
{
    public Guid Id { get; internal set; } // Not shown
    public DateTime Date { get; set; } //shown
}

令狐凌
2023-03-14

您是否尝试过在 swagger 中明确包含文档?

 类似资料:
  • 我有一个GET路由,我想在其中将url中的对象参数编码为查询字符串。 在编写 swagger 文档时,我基本上收到不允许我在类型参数中使用/类型的错误: 具有对象值的请求查询参数将在实际请求中编码。 即使 swagger在屏幕顶部显示错误,对象也会在 swagger UI 编辑器中正确呈现,但是该错误浮动在文档顶部。

  • 在swagger ui中,这样的例子是 对于嵌套对象,它工作正常(使用XML对象的标记名,而不是该对象的标题)。对于结果模式根对象,也可以。 根对象仅在body参数中存在问题。

  • 我在烧瓶项目中使用Swagger留档来记录endpoint和参数。 要定义endpoint的查询参数,请执行以下操作: 我想知道该参数是否可以在文档中显示为“必需的”,就像参数是路径的一部分时一样()。 查看文档,我只发现以下内容: 但这意味着信息要在身体上,我不能用GET请求来获取。另外,我希望它作为查询参数,而不是有效载荷的一部分。 这可能吗? 谢了。

  • 我有一个类“SubModel”,它继承自类“SuperModel”。我的REST请求返回这些类之一的对象。现在,我想在我的Swagger UI中记录,要么返回SubModel的对象,要么返回SuperModel的一个对象。我在谷歌上搜索了这个用例,发现了@ApiModel注释,但它们不起作用,有人知道我在这里做错了什么吗? 我在Swagger UI中看到的只是: 我在这个站点找到了这个例子:htt

  • 我用swagger,OpenAPI版本3为web API编写文档。我使用swagger php包从注释生成文档化的json。我有一个服务,在那里我发送post请求以添加新用户,请求的主体是json(因此参数作为json对象发送)。它有两个参数-电子邮件和密码。请求正文看起来像 这是大摇大摆的 YAML 这里是包含请求参数的参考模式(< code >/components/schemas/sign

  • 在一个基于NodeJS的项目中,loopback-component-explorer(2.7.0)附带的Swagger没有显示HTML页面中的“参数”,我们可以在其中为Restendpoint提供所需的params,而不管http动词(例如GET、POST和PATCH等)。必须remoteMethod(...)定义遵循一些大摇大摆的要求吗? 谢了。