使用 openapi-generator 解析錯誤（類型無效，將其設置為字符串）
[英]Parsing errors with openapi-generator (invalid type for type, set it to string)
問題描述
我有以下 openapi 文件架構
{
"openapi": "3.0.3",
"info": {
"title": "Hyperledger Cactus Plugin - Connector Quorum",
"description": "Can perform basic tasks on a Quorum ledger",
"version": "0.0.1"
},
"servers": [
{
"url": "https://www.cactus.stream/{basePath}",
"description": "Public test instance",
"variables": {
"basePath": {
"default": ""
}
}
},
{
"url": "http://localhost:4000/{basePath}",
"description": "Local test instance",
"variables": {
"basePath": {
"default": ""
}
}
}
],
"components": {
"schemas": {
"Web3SigningCredential": {
"type": "object",
"required": [
"type"
],
"discriminator": {
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/Web3SigningCredentialGethKeychainPassword"
},
{
"$ref": "#/components/schemas/Web3SigningCredentialCactusKeychainRef"
},
{
"$ref": "#/components/schemas/Web3SigningCredentialPrivateKeyHex"
},
{
"$ref": "#/components/schemas/Web3SigningCredentialNone"
}
],
"properties": {
"type": {
"$ref": "#/components/schemas/Web3SigningCredentialType"
}
}
},
"Web3SigningCredentialGethKeychainPassword": {
"type": "object",
"required": [
"type",
"ethAccount",
"secret"
],
"properties": {
"type": {
"$ref": "#/components/schemas/Web3SigningCredentialType"
},
"ethAccount": {
"type": "string",
"description": "The ethereum account (public key) that the credential belongs to. Basically the username in the traditional terminology of authentication.",
"minLength": 64,
"maxLength": 64,
"nullable": false
},
"secret": {
"type": "string",
"description": "A geth keychain unlock password.",
"minLength": 0,
"maxLength": 65535
}
}
},
"Web3SigningCredentialCactusKeychainRef": {
"type": "object",
"required": [
"type",
"ethAccount",
"keychainId",
"keychainEntryKey"
],
"properties": {
"type": {
"$ref": "#/components/schemas/Web3SigningCredentialType"
},
"ethAccount": {
"type": "string",
"description": "The ethereum account (public key) that the credential belongs to. Basically the username in the traditional terminology of authentication.",
"minLength": 64,
"maxLength": 64,
"nullable": false
},
"keychainEntryKey": {
"type": "string",
"description": "The key to use when looking up the the keychain entry holding the secret pointed to by the keychainEntryKey parameter.",
"minLength": 0,
"maxLength": 1024
},
"keychainId": {
"type": "string",
"description": "The keychain ID to use when looking up the the keychain plugin instance that will be used to retrieve the secret pointed to by the keychainEntryKey parameter.",
"minLength": 0,
"maxLength": 1024
}
}
},
"Web3SigningCredentialPrivateKeyHex": {
"type": "object",
"required": [
"type",
"ethAccount",
"secret"
],
"properties": {
"type": {
"$ref": "#/components/schemas/Web3SigningCredentialType"
},
"ethAccount": {
"type": "string",
"description": "The ethereum account (public key) that the credential belongs to. Basically the username in the traditional terminology of authentication.",
"minLength": 64,
"maxLength": 64,
"nullable": false
},
"secret": {
"type": "string",
"description": "The HEX encoded private key of an eth account.",
"minLength": 0,
"maxLength": 65535
}
}
},
"Web3SigningCredentialNone": {
"type": "object",
"required": [
"type"
],
"description": "Using this denotes that there is no signing required because the transaction is pre-signed.",
"properties": {
"type": {
"$ref": "#/components/schemas/Web3SigningCredentialType"
}
}
},
"Web3SigningCredentialType": {
"type": "string",
"enum": [
"CACTUS_KEYCHAIN_REF",
"GETH_KEYCHAIN_PASSWORD",
"PRIVATE_KEY_HEX",
"NONE"
]
},
"EthContractInvocationType": {
"type": "string",
"enum": [
"SEND",
"CALL"
]
},
"SolidityContractJsonArtifact": {
"type": "object",
"required": [
"contractName"
],
"properties": {
"contractName": {
"type": "string",
"nullable": false
},
"metadata": {
"type": "string",
"nullable": false
},
"bytecode": {
"type": "string",
"nullable": false
},
"deployedBytecode": {
"type": "string",
"nullable": false
},
"sourceMap": {
"type": "string",
"nullable": false
},
"deployedSourceMap": {
"type": "string",
"nullable": false
},
"sourcePath": {
"type": "string"
},
"compiler": {
"type": "object",
"additionalProperties": true,
"properties": {
"name": {
"type": "string"
},
"version": {
"type": "string"
}
}
},
"functionHashes": {
"type": "object",
"additionalProperties": true
},
"gasEstimates": {
"properties": {
"creation": {
"type": "object",
"properties": {
"codeDepositCost": {
"type": "string"
},
"executionCost": {
"type": "string"
},
"totalCost": {
"type": "string"
}
}
},
"external": {
"type": "object",
"additionalProperties": true
}
}
}
}
},
"QuorumTransactionConfig": {
"type": "object",
"required": [],
"additionalProperties": true,
"properties": {
"rawTransaction": {
"type": "string",
"nullable": false
},
"from": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"to": {
"oneOf": [
{
"type": "string"
}
]
},
"value": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"gas": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"gasPrice": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"data": {
"oneOf": [
{
"type": "string"
}
]
}
}
},
"Web3TransactionReceipt": {
"type": "object",
"required": [
"blockHash",
"blockNumber",
"transactionHash",
"transactionIndex",
"status",
"from",
"to",
"gasUsed"
],
"additionalProperties": true,
"properties": {
"status": {
"type": "boolean",
"nullable": false
},
"transactionHash": {
"type": "string",
"minLength": 64,
"maxLength": 64,
"pattern": "/^0x([A-Fa-f0-9]{64})$/"
},
"transactionIndex": {
"type": "number",
"nullable": false
},
"blockHash": {
"type": "string",
"minLength": 64,
"maxLength": 64,
"pattern": "/^0x([A-Fa-f0-9]{64})$/"
},
"blockNumber": {
"type": "number",
"nullable": false
},
"gasUsed": {
"type": "number",
"nullable": false
},
"contractAddress": {
"type": "string",
"nullable": true
},
"from": {
"type": "string",
"nullable": false
},
"to": {
"type": "string",
"nullable": false
}
}
},
"RunTransactionRequest": {
"type": "object",
"required": [
"web3SigningCredential",
"transactionConfig"
],
"properties": {
"web3SigningCredential": {
"$ref": "#/components/schemas/Web3SigningCredential",
"nullable": false
},
"transactionConfig": {
"$ref": "#/components/schemas/QuorumTransactionConfig",
"nullable": false
},
"timeoutMs": {
"type": "number",
"description": "The amount of milliseconds to wait for a transaction receipt with thehash of the transaction(which indicates successful execution) beforegiving up and crashing.",
"minimum": 0,
"default": 60000,
"nullable": false
}
}
},
"RunTransactionResponse": {
"type": "object",
"required": [
"transactionReceipt"
],
"properties": {
"transactionReceipt": {
"$ref": "#/components/schemas/Web3TransactionReceipt"
}
}
},
"DeployContractSolidityBytecodeV1Request": {
"type": "object",
"required": [
"bytecode",
"web3SigningCredential"
],
"properties": {
"web3SigningCredential": {
"$ref": "#/components/schemas/Web3SigningCredential",
"nullable": false
},
"bytecode": {
"type": "string",
"nullable": false,
"minLength": 1,
"maxLength": 24576,
"description": "See https://ethereum.stackexchange.com/a/47556 regarding the maximum length of the bytecode"
},
"gas": {
"type": "number",
"nullable": false
},
"gasPrice": {
"type": "string",
"nullable": false
},
"timeoutMs": {
"type": "number",
"description": "The amount of milliseconds to wait for a transaction receipt with theaddress of the contract(which indicates successful deployment) beforegiving up and crashing.",
"minimum": 0,
"default": 60000,
"nullable": false
}
}
},
"DeployContractSolidityBytecodeV1Response": {
"type": "object",
"required": [
"transactionReceipt"
],
"properties": {
"transactionReceipt": {
"$ref": "#/components/schemas/Web3TransactionReceipt"
}
}
},
"InvokeContractV1Request": {
"type": "object",
"required": [
"contractAbi",
"web3SigningCredential",
"contractAddress",
"invocationType",
"methodName",
"params"
],
"properties": {
"web3SigningCredential": {
"$ref": "#/components/schemas/Web3SigningCredential",
"nullable": false
},
"contractAbi": {
"description": "The application binary interface of the solidity contract",
"type": "array",
"items": {},
"nullable": false
},
"contractAddress": {
"type": "string",
"nullable": false
},
"invocationType": {
"$ref": "#/components/schemas/EthContractInvocationType",
"nullable": false,
"description": "Indicates wether it is a CALL or a SEND type of invocation where only SEND ends up creating an actual transaction on the ledger."
},
"methodName": {
"description": "The name of the contract method to invoke.",
"type": "string",
"nullable": false,
"minLength": 1,
"maxLength": 2048
},
"params": {
"description": "The list of arguments to pass in to the contract method being invoked.",
"type": "array",
"default": [],
"items": {}
},
"gas": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"gasPrice": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"timeoutMs": {
"type": "number",
"description": "The amount of milliseconds to wait for a transaction receipt beforegiving up and crashing. Only has any effect if the invocation type is SEND",
"minimum": 0,
"default": 60000,
"nullable": false
}
}
},
"InvokeContractV1Response": {
"type": "object",
"properties": {
"transactionReceipt": {
"$ref": "#/components/schemas/Web3TransactionReceipt"
},
"callOutput": {}
}
}
}
},
"paths": {
"/api/v1/plugins/@hyperledger/cactus-plugin-ledger-connector-quorum/deploy-contract-solidity-bytecode": {
"post": {
"operationId": "apiV1QuorumDeployContractSolidityBytecode",
"summary": "Deploys the bytecode of a Solidity contract.",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeployContractSolidityBytecodeV1Request"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeployContractSolidityBytecodeV1Response"
}
}
}
}
}
}
},
"/api/v1/plugins/@hyperledger/cactus-plugin-ledger-connector-quorum/run-transaction": {
"post": {
"operationId": "apiV1QuorumRunTransaction",
"summary": "Executes a transaction on a quorum ledger",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RunTransactionRequest"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RunTransactionResponse"
}
}
}
}
}
}
},
"/api/v1/plugins/@hyperledger/cactus-plugin-ledger-connector-quorum/invoke-contract": {
"post": {
"operationId": "apiV1QuorumInvokeContract",
"summary": "Invokeds a contract on a quorum ledger",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvokeContractV1Request"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvokeContractV1Response"
}
}
}
}
}
}
}
}
}
基本上簡而言之，架構（問題所在）就像
Web3SigningCredential -> { Web3SigningCredentialPrivateKeyHex , Web3SigningCredentialGethKeychainPassword , Web3SigningCredentialNone , Web3SigningCredentialCactusKeychainRef } -> Web3SigningCredentialType
當我嘗試使用解析它時
openapi-generator generate --input-spec file_mentioned_above -g go -o some_path
我收到一條錯誤消息
Exception in thread "main" java.lang.RuntimeException: Could not process model 'Web3SigningCredential'.Please make sure that your schema is correct!
at org.openapitools.codegen.DefaultGenerator.generateModels(DefaultGenerator.java:477)
at org.openapitools.codegen.DefaultGenerator.generate(DefaultGenerator.java:852)
at org.openapitools.codegen.cmd.Generate.execute(Generate.java:432)
at org.openapitools.codegen.cmd.OpenApiGeneratorCommand.run(OpenApiGeneratorCommand.java:32)
at org.openapitools.codegen.OpenAPIGenerator.main(OpenAPIGenerator.java:66)
Caused by: java.lang.RuntimeException: 'Web3SigningCredential' defines discriminator 'type', but the referenced schema 'Web3SigningCredentialGethKeychainPassword' is incorrect. invalid type for type, set it to string
at org.openapitools.codegen.DefaultCodegen.getOneOfAnyOfDescendants(DefaultCodegen.java:2792)
at org.openapitools.codegen.DefaultCodegen.createDiscriminator(DefaultCodegen.java:2897)
at org.openapitools.codegen.DefaultCodegen.fromModel(DefaultCodegen.java:2249)
at org.openapitools.codegen.DefaultGenerator.processModels(DefaultGenerator.java:1162)
at org.openapitools.codegen.DefaultGenerator.generateModels(DefaultGenerator.java:472)
但是當我在上述命令中使用語言typescript-axios時，同樣的工作
openapi-generator generate --input-spec file_mentioned_above -g typescript-axios -o some_path
我對上述規范文件做錯了什么，還是與 openapi-generator 的 Go 有關？
1 個解決方案
解決方案1
0 2021-01-12 17:38:19
嘗試重新組織架構以使用allOf inheritance 而不是oneOf 。 還要確保在基本模式中指定鑒別器mapping 。 如果沒有mapping ，則 API 定義假定子模式與鑒別器屬性值具有相同的名稱，而您的示例中並非如此。
這是一個 YAML 版本，您可以使用https://www.json2yaml.com/將其轉換為 JSON。
components:
schemas:
Web3SigningCredential:
type: object
required:
- type
discriminator:
propertyName: type
mapping:
CACTUS_KEYCHAIN_REF: Web3SigningCredentialCactusKeychainRef
GETH_KEYCHAIN_PASSWORD: Web3SigningCredentialGethKeychainPassword
PRIVATE_KEY_HEX: Web3SigningCredentialPrivateKeyHex
NONE: Web3SigningCredentialNone
properties:
type:
$ref: '#/components/schemas/Web3SigningCredentialType'
Web3SigningCredentialGethKeychainPassword:
allOf:
- $ref: '#/components/schemas/Web3SigningCredential'
- type: object
required:
- ethAccount
- secret
properties:
ethAccount:
type: string
description: The ethereum account (public key) that the credential belongs to. Basically the username in the traditional terminology of authentication.
minLength: 64
maxLength: 64
nullable: false
secret:
type: string
description: A geth keychain unlock password.
minLength: 0
maxLength: 65535
相應地更新Web3SigningCredentialCactusKeychainRef 、 Web3SigningCredentialPrivateKeyHex和Web3SigningCredentialNone模式。
如何修復從使用 application/x-www-form-urlencoded 內容類型的 API 的 openapi go 代碼生成器獲取的驗證錯誤？
[英]How to fix validation error getting from openapi go code generator for an API which consumes application/x-www-form-urlencoded content type?
map[string]*type "無效的內存地址或 nil 指針取消引用"
[英]map[string]*type "invalid memory address or nil pointer dereference"
聲明:本站的技術帖子網頁，遵循CC BY-SA 4.0協議，如果您需要轉載，請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.
相關問題
類型為func（int）字符串的間接無效
如何修復從使用 application/x-www-form-urlencoded 內容類型的 API 的 openapi go 代碼生成器獲取的驗證錯誤？
map[string]*type "無效的內存地址或 nil 指針取消引用"
在 jwt-go 中解析 JWT Auth 令牌時，密鑰的類型無效
在 go 中鍵入斷言錯誤
密鑰的類型無效
Golang：Type [type] 不是表達式； json配置解析
在Golang中將JSONSchema解析為結構類型
如何檢查errors.Errorf（）中的類型錯誤？
數據存儲：Put上的實體類型無效
相關標簽