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

如何给OpenAPI/Swagger类添加类字段描述?

阎淮晨
2023-03-14

如何在生成的 Swagger/OpenApi json 中包含类字段描述?

例如,我希望 swagger json 中的类属性包含描述

"properties": {
                 "customerId": {
                  "type": "string",
                  "description": "This is my foo foo foo"
              },

我希望下面的代码会产生这样的结果,但是它没有。它只包括includes 类型

public class Customer
{
    [JsonRequired]
    [Description("This is my foo foo foo")]
    public string CustomerId { get; set; } }
}

共有1个答案

章哲彦
2023-03-14

在这种情况下,我能够使用[开放Api属性(描述=“傻瓜”)]

 类似资料:
  • 我看到过一些关于的博客,这些博客似乎可以很好地为类添加行为。 但是,如果我有一个并且我要怎么办?作为一个case类,我不能扩展它(不推荐/强烈不鼓励从case类继承)。这些皮条客模式是否允许我将数据添加到case类中?

  • OpenAPI3.0规范规定,没有任何类型的模式将匹配任何数据类型。 没有类型的模式匹配任何数据类型--数字、字符串、对象等等。 因此,对此进行建模的正确方法是下面的Swagger定义,其中没有属性: 但是,每个开放问题Swagger-core#3834,Java值都映射到OpenAPI类型,而不是任意类型。如上所述,这意味着这样的API返回或接受不是OpenAPI的类型是不正确的,例如、、等。

  • 我在使用OpenApi和Spring定义API时遇到了一些问题。我正在使用此依赖项: 我的问题是,我想在不同的Api响应上定义一个@模式,但在每个响应中使用不同的描述和示例。 现在我有一个这样的回答: 还有其他类似的反应。。。 因此,我有三个不同描述和示例的对象“Balance”,但当它生成文档时,使用该对象的所有响应和字段都采用相同的描述和示例。 我已经看到,在生成的文件中,我将所有这些项目都带

  • 使用FastAPI,如何将字符集添加到OpenAPI(Swagger)文档请求头上的内容类型(媒体类型)中? OpenAPI(http:///docs)显示“application/x-www-form-urlencoded”。 我试着改变,就像: 但不是添加字符集=cp932 我想在请求时将“Application/x-www-form-urlencoded; charset=cp932”设置为

  • 我找到了这个项目https://github.com/OAI/OpenAPI-Specification据我所知,我们可以用文件。而且,我能看到http://editor.swagger.io/它可以被渲染成文件。 我的问题是-我怎么能生成静态页面从文件?有任何教程的Spring引导应用程序吗?我应该以某种方式设置文件昂首阔步的配置和获得文件留档?

  • 在graphiql中,有一个描述字段,但它总是说“自我描述”。如何向架构添加描述?