在Swager的查询参数中添加文本区域

Question

我刚开始招摇。目前，我使用的是swagger ui v2.1.4版。我的API由查询参数组成。其中一个参数接受JSON主体。我想在文本区显示这个参数。目前，它显示在输入标记中。此外，我希望在该文本区域下方显示参数内容类型。请帮我怎么做？

Answer 1

OpenAPI 3.0现在支持对象作为查询参数

Answer 2

在描述参数时添加< code >格式，例如:

parameters:
  - name: key
    type: string
    in: query
    format: textarea

在初始化＜code＞swagger ui＜/code＞时添加自定义插件

       // Custom plugin that adds extra stuff
       const TextAreaPlugin = function() {
           return {
               wrapComponents: {
                   // add text above InfoContainer - same effect as above title
                   JsonSchema_string: (Original, runtime) => (props) => {
                       var React = runtime.React,
                           schema = props.schema || {},
                           errors = props.errors || {},
                           format = schema.format || "",
                           isDisabled = props.disabled;

                        errors = errors.toJS ? errors.toJS() : []

                       function handleOnChange(e) {
                           const inputValue = e.target.value;

                           props.onChange(inputValue)
                       }

                       if (format == "textarea") {
                           return React.createElement("div", null,
                                   React.createElement("textarea", {
                                       title: errors.length ? errors : "",
                                       className: errors.length ? "invalid" : "",
                                       value: props.value,
                                       disabled: isDisabled,
                                       onChange: handleOnChange
                                   })
                           )
                       }

                       return React.createElement(Original, props);
                   },
               }
           }
       };

       // Begin Swagger UI call region
        var ui = SwaggerUIBundle({
            url: "./swagger.json",
            dom_id: '#swagger-ui',
            deepLinking: true,
            presets: [
                SwaggerUIBundle.presets.apis,
                SwaggerUIStandalonePreset
            ],
            plugins: [
                TextAreaPlugin,
                SwaggerUIBundle.plugins.DownloadUrl
            ],
            layout: "StandaloneLayout"
        });

Answer 3

在当前的 swagger 2.0 规范中，不能使用复杂值作为查询参数。它们可以是基元或基元值数组。您可以直接从规范中了解更多信息：

https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#parameter-object

由于这是一个普遍要求的特性，它将在下一版本的规范中得到支持，但该特性不会被移植到swagger 2.0工具中。