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

如何使大摇大摆的UI接受带有可选字段的请求体

巫马承德
2023-03-14

嗯,标题很容易理解,但要详细说明:

{
    name: "name",
    description: "description",
    github: "github",
    logo: "logo",
    app: "app"
}

编辑:根据@Anatoly的要求,这是昂首阔步的路线定义:

post: {
    summary: 'Create a new project',
    tags: ['projects'],
    requestBody: {
        content: {
            'application/json': {
                schema: {
                    $ref: '#/components/schemas/Project'
                }
            }
        }
    }
},
components: {
    schemas: {
        Project: {
            type: 'object',
            properties: {
                name: {
                    type: 'string'
                },
                description: {
                    type: 'string'
                },
                github: {
                    type: 'string'
                },
                logo: {
                    type: 'string'
                },
                app: {
                    type: 'string'
                }
            }
        }
    }
}

共有1个答案

尤博达
2023-03-14

除了path参数之外,所有参数都是可选的,除非它们的required属性为true

app:
  type:string
  required:true

请参阅https://swagger.io/docs/specification/description-parameters/中的标题必需和可选参数

 类似资料:
  • 我使用SpringFox库来获取我的Spring Boot应用程序的Rest文档。当我单击模型时,所有元素都作为可选元素返回。有没有办法将必需的元素显示为必需元素?是否需要添加任何其他配置?

  • 有没有人用spring-data-rest配置了swagger。我知道swagger有DocumentationConfig类,它扫描所有spring-mvc请求映射。但是,如何将其用于spring-data-rest,因为没有定义显式的请求映射。非常感谢在这方面的任何帮助。此外,我还想知道,是否有其他支持Spring-Data-REST的文档框架。

  • SpringDoc 1.5.3(最新版本) SwaggerUI 3.41.0(最新版本) Swagger UI显示了的好字段。 我有一个POSTendpoint,所以我使用了。 我可以发送一个JSON,它解析成我的body对象。到目前为止还不错。 但是,Swagger UI只显示一个文本区域,我应该在其中放置整个JSON。这不太方便。 我希望Swagger UI为请求类的每个属性显示单独的字段;没

  • 我们在我们的泽西应用程序中使用了@Role允许注释来限制用户对应用编程接口某些部分的访问。我们如何在SwaggerUI中显示这些信息? 到目前为止,我已经用@ApiOperation注释了方法以显示in/out参数,并尝试使用@Authorization/@AuthorizationScope,但我只为我们不使用的oauth2显示了它。最接近out case的是ApiKeyAuthDefiniti

  • 编译得很好,但当我使用BootRun命令启动应用程序时,它失败了,原因是: 会有什么问题?不兼容Java9?那我能让它发挥作用吗?

  • 给定以下架构定义(这是定义所需属性的有效方法):