docusaurus-openapi配置参考

订阅 所有频道

Subscribe Youtube Channels

有偿 远程协助

Paid Support

docusaurus-openapi插件,配置参考

json版本

{
  "openapi": "3.0.0",
  "servers": [
    {
      "url": "https://api.vultr.com/v2/"
    }
  ],
  "info": {
    "version": "1.0.0",
    "title": "Vultr 2.0 API"
  },

  "paths": {
    "/instance": {
      "get": {
        "summary": "List Instances",
        "description": "罗列出所有运行中的服务器",
        "operationId": "样例",
        "security": [
          {
            "BearerAuth": []
          }
        ]
      },
      "post": {
        "summary": "Create Hysteria Instance",
        "description": "hysteria节点搭建",
        "operationId": "hysteria",
        "responses": {
          "202": {
            "description": "Created"
          },
          "400": {
            "description": "Bad Request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "Forbidden"
          },
          "404": {
            "description": "Not Found"
          }
        },       "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "region": {
                  "type": "string",
                  "example": "lax"
                },
                "plan": {
                  "type": "string",
                  "example": "vhp-1c-1gb-amd{region}"
                },
                "label": {
                  "type": "string",
                  "example": "ycycxz"
                },

                "os_id": {
                  "type": "int64",
                  "example": 1946
                },
                "user-data": {
                  "type": "string",
                  "example": "IyEvYmluL2Jhc2gKdWZ3IC0tZm9yY2UgcmVzZXQKd2dldCAtcTRPIC91c3IvbG9jYWwvYmluL3ljeWN4ei1zaW5nLWJveCBodHRwczovL3ljeWN4ei5jb20vZGwveWN5Y3h6LXNpbmctYm94LWxpbnV4LWFtZDY0CmNobW9kICt4IC91c3IvbG9jYWwvYmluL3ljeWN4ei1zaW5nLWJveApta2RpciAtcCAvZXRjL3ljeWN4ei1zaW5nLWJveAp5Y3ljeHotc2luZy1ib3ggdmVyc2lvbgpjYXQgPDxFT0YgPiAvZXRjL3ljeWN4ei1zaW5nLWJveC95Y3ljeHouanNvbgp7CiAgImluYm91bmRzIjogWwogICAgewogICAgICAidHlwZSI6ICJzb2NrcyIsCiAgICAgICJsaXN0ZW5fcG9ydCI6IDQyMzI0LAogICAgICAidXNlcnMiOiBbCiAgICAgICAgewogICAgICAgICAgInVzZXJuYW1lIjogInljeWN4eiIsCiAgICAgICAgICAicGFzc3dvcmQiOiAieWN5Y3h6IgogICAgICAgIH0KICAgICAgXQogICAgfQogIF0KfQpFT0YKY2F0IDw8RU9GID4gL2V0Yy9zeXN0ZW1kL3N5c3RlbS95Y3ljeHotc2luZy1ib3guc2VydmljZQpbVW5pdF0KRGVzY3JpcHRpb249eWN5Y3h6LXNpbmctYm94CkFmdGVyPW5ldHdvcmstb25saW5lLnRhcmdldAoKW1NlcnZpY2VdCkxpbWl0QVM9aW5maW5pdHkKTGltaXROT0ZJTEU9aW5maW5pdHkKTGltaXROUFJPQz1pbmZpbml0eQpUYXNrc01heD1pbmZpbml0eQpFeGVjU3RhcnQ9L3Vzci9sb2NhbC9iaW4veWN5Y3h6LXNpbmctYm94IHJ1biAtYyAvZXRjL3ljeWN4ei1zaW5nLWJveC95Y3ljeHouanNvbgoKW0luc3RhbGxdCldhbnRlZEJ5PW11bHRpLXVzZXIudGFyZ2V0CkVPRgpzeXN0ZW1jdGwgZGFlbW9uLXJlbG9hZApzeXN0ZW1jdGwgZW5hYmxlIHljeWN4ei1zaW5nLWJveApzeXN0ZW1jdGwgc3RhcnQgeWN5Y3h6LXNpbmctYm94"
                },
                "hostname": {
                  "type": "string",
                  "example": "ycycxz"
                },

                "tags": {
                  "type": "array",
                  "example": ["ycycxz", "hysteria"]
                }
              },
              "required": ["region", "plan"]
            }
          }
        },
        "security": [
          {
            "BearerAuth": []
          }
        ]
      }
    }
  },
  "components": {
    "securitySchemes": {
      "BearerAuth": { "type": "http", "scheme": "BeAreR" }
    }
  }
}