API first tutorial #192
API first tutorial #192
Conversation
|
Thanks for submitting your work on a (new) tutorial! Some suggestions, which might help:
Also please find further help for creating tutorials here or more help regarding the tutorial syntax here. You can view the generated tutorials of this PR here in a few minutes. You just have to wait for the run of the deployment action to finish. When you think you are done writing the tutorial try the tutorial on the deveplopment area and check if you explained every step in a way someone who is trying to learn what you are teaching can understand. Ideally ask someone to have a look on what you have done and have that part double checked because this is very important. |
|
Please mark your pull request as draft until it is finished: https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/changing-the-stage-of-a-pull-request#converting-a-pull-request-to-a-draft |
GuentherJulian
requested review from
EduardKrieger,
mustafaokyay and
rafaelvicariabarker
| @@ -0,0 +1,90 @@ | |||
| = API first approach with OpenAPI generator | |||
There was a problem hiding this comment.
The title/subtitle is missing the info that it is a quarkus tutorial.
There was a problem hiding this comment.
It is actually a 'general' tutorial. I did use Quarkus, but you can do it the same way in Spring.
I added some information about it in the description, but I would leave the title as it is.
| @@ -0,0 +1,90 @@ | |||
| = API first approach with OpenAPI generator | |||
| ==== | |||
There was a problem hiding this comment.
Please add tags -> see docs on how to do it
There was a problem hiding this comment.
I have added tags, but where are the tags used? They are not added in the tutorial if I see that right
| [step] | ||
| == Create the Quarkus project | ||
| -- | ||
| executeCommand("mvn io.quarkus.platform:quarkus-maven-plugin:2.6.1.Final:create \"-DprojectGroupId=com.devonfw.quarkus\" \"-DprojectArtifactId=api-first-tutorial\" \"-Dextensions=resteasy-jackson\"","mvn io.quarkus.platform:quarkus-maven-plugin:2.6.1.Final:create -DprojectGroupId=com.devonfw.quarkus -DprojectArtifactId=api-first-tutorial -Dextensions=resteasy-jackson") |
There was a problem hiding this comment.
Shouldn't we use the devon command to create the project?
There was a problem hiding this comment.
The devon command can only create Spring projects at the moment. That's why I did it this way.
Tutorial that shows how to create a REST API from an OpenAPI specification using OpenAPI generator