feat(#1156): provide test api generator #1160
Conversation
tschlat
force-pushed
the
issue/1156/test_api_generator_TS
branch
from
4b7b9f9
to
e05ec95
Compare
core/citrus-api/src/main/java/org/citrusframework/testapi/GeneratedApi.java
Show resolved
Hide resolved
src/manual/testapi.adoc
Outdated
There was a problem hiding this comment.
this file must be included somewhere, right? I would suggest to add it after "5. Running tests in Java".
There was a problem hiding this comment.
Moved it to connector-openapi.adoc and embdedded it into that context.
src/manual/testapi.adoc
Outdated
| = Test API Generation | ||
|
|
||
| == OpenAPI: A Standard for API Description | ||
| OpenAPI, formerly known as Swagger, is a widely adopted standard for describing RESTful APIs. It provides a |
There was a problem hiding this comment.
I usually do one sentence per line in *.adoc. that makes it much more comparable in later pull-requests. would you mind giving it a refactoring? 👼🏼 sorry...
There was a problem hiding this comment.
It's currently not really done that way but i changed my code respectively.
src/manual/testapi.adoc
Outdated
|
|
||
| == OpenAPI: A Standard for API Description | ||
| OpenAPI, formerly known as Swagger, is a widely adopted standard for describing RESTful APIs. It provides a | ||
| language-agnostic interface to define the structure of APIs in a human-readable format, typically using YAML |
There was a problem hiding this comment.
| language-agnostic interface to define the structure of APIs in a human-readable format, typically using YAML | |
| language-agnostic interface to define the structure of APIs in a human- and at the same time machine-readable format, typically using YAML |
There was a problem hiding this comment.
I have embedded the documentation into the existing open api documentation. Therefore, I dont need this abstract any more. It has been removed.
src/manual/testapi.adoc
Outdated
| OpenAPI specifications are commonly used to generate various artifacts such as client libraries, server stubs, and | ||
| documentation. By capturing the structure and behavior of APIs in a machine-readable format, OpenAPI enables | ||
| seamless code generation, saving time and ensuring consistency across different implementations. |
There was a problem hiding this comment.
| OpenAPI specifications are commonly used to generate various artifacts such as client libraries, server stubs, and | |
| documentation. By capturing the structure and behavior of APIs in a machine-readable format, OpenAPI enables | |
| seamless code generation, saving time and ensuring consistency across different implementations. |
you've already said that imo.
test-api-generator/citrus-test-api-generator-maven-plugin/pom.xml
Outdated
Show resolved
Hide resolved
test-api-generator/citrus-test-api-generator-maven-plugin/pom.xml
Outdated
Show resolved
Hide resolved
|
@tschlat awesome work! please bear with me as I need some more time to have a closer look |
tschlat
force-pushed
the
issue/1156/test_api_generator_TS
branch
from
50a7341
to
0b59743
Compare
I have added code for the test API generator plus documentation. The generator has been implemented having XML tests in mind. Therefore, usage within Java DSL is a little cumbersome and needs a rework. We propose to add this change as work in progress. It is quite isolated.
I have added #1161 and #1163 to finish this up.