How to handle OpenAPI 3 (swagger) with Maven plugin
I have written an API compliant with Openapi 3 (https://swagger.io/docs/specification/basic-structure/) and now I have tried and failed to generate Java Spring objects as I were previously doing with a swagger definition and its associated maven plugin.
So far, I have a basic API definition and in my pom.xml file I have added
<dependency>
<groupId>org.openapitools</groupId>
<art ifactId>openapi-generator-cli</artifactId>
<version>3.3.3</version>
</dependency>
when executing mvn install, I got this error :
com.fasterxml.jackson.core.JsonParseException: Unrecognized token 'openapi': was expecting ('true', 'false' or 'null')
at [Source: definitionDEFINITION.yml; line: 1, column: 9]
here is my first lines of my definition.yml file :
openapi: 3.0.0
info:
title: Demo API
description: This is a basic REST API implementing the [Open API Specification](https://en.wikipedia.org/wiki/OpenAPI_Specification).
version: 0.0.1
Can anyone help, please?
maven swagger openapi codegen
edited Nov 19 '18 at 7:50
Al Imran
685417
asked Nov 19 '18 at 6:11
vpavpa
61
add a comment |
I have written an API compliant with Openapi 3 (https://swagger.io/docs/specification/basic-structure/) and now I have tried and failed to generate Java Spring objects as I were previously doing with a swagger definition and its associated maven plugin.
So far, I have a basic API definition and in my pom.xml file I have added
<dependency>
<groupId>org.openapitools</groupId>
<art ifactId>openapi-generator-cli</artifactId>
<version>3.3.3</version>
</dependency>
when executing mvn install, I got this error :
com.fasterxml.jackson.core.JsonParseException: Unrecognized token 'openapi': was expecting ('true', 'false' or 'null')
at [Source: definitionDEFINITION.yml; line: 1, column: 9]
here is my first lines of my definition.yml file :
openapi: 3.0.0
info:
title: Demo API
description: This is a basic REST API implementing the [Open API Specification](https://en.wikipedia.org/wiki/OpenAPI_Specification).
version: 0.0.1
Can anyone help, please?
maven swagger openapi codegen
edited Nov 19 '18 at 7:50
Al Imran
685417
asked Nov 19 '18 at 6:11
vpavpa
61
Is this the actual indentation of your definition.yml or just copy-paste formatting issues? The indentation is wrong -infomust be on the same level asopenapi. Paste your YAML into editor.swagger.io to make sure the syntax is correct.
– Helen
Nov 19 '18 at 8:14
this is just a copy-paste. My yaml file is correct and no error is displayed when edited in Swagger editor. But it looks like "openapi" tag is not recognise.
– vpa
Nov 20 '18 at 14:29
add a comment |
I have written an API compliant with Openapi 3 (https://swagger.io/docs/specification/basic-structure/) and now I have tried and failed to generate Java Spring objects as I were previously doing with a swagger definition and its associated maven plugin.
So far, I have a basic API definition and in my pom.xml file I have added
<dependency>
<groupId>org.openapitools</groupId>
<art ifactId>openapi-generator-cli</artifactId>
<version>3.3.3</version>
</dependency>
when executing mvn install, I got this error :
com.fasterxml.jackson.core.JsonParseException: Unrecognized token 'openapi': was expecting ('true', 'false' or 'null')
at [Source: definitionDEFINITION.yml; line: 1, column: 9]
here is my first lines of my definition.yml file :
openapi: 3.0.0
info:
title: Demo API
description: This is a basic REST API implementing the [Open API Specification](https://en.wikipedia.org/wiki/OpenAPI_Specification).
version: 0.0.1
Can anyone help, please?
maven swagger openapi codegen
edited Nov 19 '18 at 7:50
Al Imran
685417
asked Nov 19 '18 at 6:11
vpavpa
61
I have written an API compliant with Openapi 3 (https://swagger.io/docs/specification/basic-structure/) and now I have tried and failed to generate Java Spring objects as I were previously doing with a swagger definition and its associated maven plugin.
So far, I have a basic API definition and in my pom.xml file I have added
<dependency>
<groupId>org.openapitools</groupId>
<art ifactId>openapi-generator-cli</artifactId>
<version>3.3.3</version>
</dependency>
when executing mvn install, I got this error :
com.fasterxml.jackson.core.JsonParseException: Unrecognized token 'openapi': was expecting ('true', 'false' or 'null')
at [Source: definitionDEFINITION.yml; line: 1, column: 9]
here is my first lines of my definition.yml file :
openapi: 3.0.0
info:
title: Demo API
description: This is a basic REST API implementing the [Open API Specification](https://en.wikipedia.org/wiki/OpenAPI_Specification).
version: 0.0.1
Can anyone help, please?
maven swagger openapi codegen
maven swagger openapi codegen
edited Nov 19 '18 at 7:50
Al Imran
685417
asked Nov 19 '18 at 6:11
vpavpa
61
edited Nov 19 '18 at 7:50
Al Imran
685417
asked Nov 19 '18 at 6:11
vpavpa
61
edited Nov 19 '18 at 7:50
Al Imran
685417
edited Nov 19 '18 at 7:50
Al Imran
685417
edited Nov 19 '18 at 7:50
Al Imran
685417
685417
asked Nov 19 '18 at 6:11
vpavpa
61
asked Nov 19 '18 at 6:11
vpavpa
61
asked Nov 19 '18 at 6:11
vpavpa
61
61
Is this the actual indentation of your definition.yml or just copy-paste formatting issues? The indentation is wrong -infomust be on the same level asopenapi. Paste your YAML into editor.swagger.io to make sure the syntax is correct.
– Helen
Nov 19 '18 at 8:14
this is just a copy-paste. My yaml file is correct and no error is displayed when edited in Swagger editor. But it looks like "openapi" tag is not recognise.
– vpa
Nov 20 '18 at 14:29
add a comment |
Is this the actual indentation of your definition.yml or just copy-paste formatting issues? The indentation is wrong -infomust be on the same level asopenapi. Paste your YAML into editor.swagger.io to make sure the syntax is correct.
– Helen
Nov 19 '18 at 8:14
this is just a copy-paste. My yaml file is correct and no error is displayed when edited in Swagger editor. But it looks like "openapi" tag is not recognise.
– vpa
Nov 20 '18 at 14:29
Is this the actual indentation of your definition.yml or just copy-paste formatting issues? The indentation is wrong -
info must be on the same level as openapi. Paste your YAML into editor.swagger.io to make sure the syntax is correct.– Helen
Nov 19 '18 at 8:14
Is this the actual indentation of your definition.yml or just copy-paste formatting issues? The indentation is wrong -
info must be on the same level as openapi. Paste your YAML into editor.swagger.io to make sure the syntax is correct.– Helen
Nov 19 '18 at 8:14
this is just a copy-paste. My yaml file is correct and no error is displayed when edited in Swagger editor. But it looks like "openapi" tag is not recognise.
– vpa
Nov 20 '18 at 14:29
this is just a copy-paste. My yaml file is correct and no error is displayed when edited in Swagger editor. But it looks like "openapi" tag is not recognise.
– vpa
Nov 20 '18 at 14:29
add a comment |
1 Answer
1
active
oldest
votes
I'm currently working on openapi-generator-maven-plugin to generate Java classes from an OpenAPI JSON schema.
The errors looks like a syntax problem. So first make sure your schema is syntactically correct and looks like this:
{
"openapi": "3.0.0",
"info": {
"title": "Demo API",
"description": "This is a basic REST API implementing the [Open API Specification](https://en.wikipedia.org/wiki/OpenAPI_Specification).",
"version": "0.0.1"
},
# Schema definition goes here
}
answered Nov 20 '18 at 15:34
R4FT3RR4FT3R
216
add a comment |
Your Answer
StackExchange.ifUsing("editor", function () {
StackExchange.using("externalEditor", function () {
StackExchange.using("snippets", function () {
StackExchange.snippets.init();
});
});
}, "code-snippets");
StackExchange.ready(function() {
var channelOptions = {
tags: "".split(" "),
id: "1"
};
initTagRenderer("".split(" "), "".split(" "), channelOptions);
StackExchange.using("externalEditor", function() {
// Have to fire editor after snippets, if snippets enabled
if (StackExchange.settings.snippets.snippetsEnabled) {
StackExchange.using("snippets", function() {
createEditor();
});
}
else {
createEditor();
}
});
function createEditor() {
StackExchange.prepareEditor({
heartbeatType: 'answer',
autoActivateHeartbeat: false,
convertImagesToLinks: true,
noModals: true,
showLowRepImageUploadWarning: true,
reputationToPostImages: 10,
bindNavPrevention: true,
postfix: "",
imageUploader: {
brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
allowUrls: true
},
onDemand: true,
discardSelector: ".discard-answer"
,immediatelyShowMarkdownHelp:true
});
}
});
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53369190%2fhow-to-handle-openapi-3-swagger-with-maven-plugin%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
1 Answer
1
active
oldest
votes
1 Answer
1
active
oldest
votes
active
oldest
votes
active
oldest
votes
I'm currently working on openapi-generator-maven-plugin to generate Java classes from an OpenAPI JSON schema.
The errors looks like a syntax problem. So first make sure your schema is syntactically correct and looks like this:
{
"openapi": "3.0.0",
"info": {
"title": "Demo API",
"description": "This is a basic REST API implementing the [Open API Specification](https://en.wikipedia.org/wiki/OpenAPI_Specification).",
"version": "0.0.1"
},
# Schema definition goes here
}
answered Nov 20 '18 at 15:34
R4FT3RR4FT3R
216
add a comment |
I'm currently working on openapi-generator-maven-plugin to generate Java classes from an OpenAPI JSON schema.
The errors looks like a syntax problem. So first make sure your schema is syntactically correct and looks like this:
{
"openapi": "3.0.0",
"info": {
"title": "Demo API",
"description": "This is a basic REST API implementing the [Open API Specification](https://en.wikipedia.org/wiki/OpenAPI_Specification).",
"version": "0.0.1"
},
# Schema definition goes here
}
answered Nov 20 '18 at 15:34
R4FT3RR4FT3R
216
add a comment |
I'm currently working on openapi-generator-maven-plugin to generate Java classes from an OpenAPI JSON schema.
The errors looks like a syntax problem. So first make sure your schema is syntactically correct and looks like this:
{
"openapi": "3.0.0",
"info": {
"title": "Demo API",
"description": "This is a basic REST API implementing the [Open API Specification](https://en.wikipedia.org/wiki/OpenAPI_Specification).",
"version": "0.0.1"
},
# Schema definition goes here
}
answered Nov 20 '18 at 15:34
R4FT3RR4FT3R
216
I'm currently working on openapi-generator-maven-plugin to generate Java classes from an OpenAPI JSON schema.
The errors looks like a syntax problem. So first make sure your schema is syntactically correct and looks like this:
{
"openapi": "3.0.0",
"info": {
"title": "Demo API",
"description": "This is a basic REST API implementing the [Open API Specification](https://en.wikipedia.org/wiki/OpenAPI_Specification).",
"version": "0.0.1"
},
# Schema definition goes here
}
answered Nov 20 '18 at 15:34
R4FT3RR4FT3R
216
edited Nov 20 '18 at 15:54
answered Nov 20 '18 at 15:34
R4FT3RR4FT3R
216
answered Nov 20 '18 at 15:34
R4FT3RR4FT3R
216
answered Nov 20 '18 at 15:34
R4FT3RR4FT3R
216
216
add a comment |
add a comment |
Thanks for contributing an answer to Stack Overflow!
- Please be sure to answer the question. Provide details and share your research!
But avoid …
- Asking for help, clarification, or responding to other answers.
- Making statements based on opinion; back them up with references or personal experience.
To learn more, see our tips on writing great answers.
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53369190%2fhow-to-handle-openapi-3-swagger-with-maven-plugin%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Is this the actual indentation of your definition.yml or just copy-paste formatting issues? The indentation is wrong -
infomust be on the same level asopenapi. Paste your YAML into editor.swagger.io to make sure the syntax is correct.– Helen
Nov 19 '18 at 8:14
this is just a copy-paste. My yaml file is correct and no error is displayed when edited in Swagger editor. But it looks like "openapi" tag is not recognise.
– vpa
Nov 20 '18 at 14:29