Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Convert HTTP calls to an OpenAPI spec #653

Open
jaguililla opened this issue Aug 28, 2023 · 0 comments
Open

Convert HTTP calls to an OpenAPI spec #653

jaguililla opened this issue Aug 28, 2023 · 0 comments

Comments

@jaguililla
Copy link
Member

Code a function to convert a list of requests/responses into an OpenAPI spec.

The calls will be grouped by path/method. All requests and responses bodies of the calls must be added as examples.

Another function will allow to merge YAML/JSON files to the previously generated spec to complete the final spec. The com.hexagonkt.core.merge method can be helpful for this (along with the serialization modules).

Call bodies (from request and response) can be of any class, that type can be used to create the schema of the bodies in the spec. For that purpose, the hexagon_extra/processor module output can be used.

These methods should be placed on the http/rest_tools module (on the com.hexagonkt.http.test.openapi package).

For information on how to build the project and pass the tests please refer to the contributing guide.

If you have any question or suggestion, please feel free to use this issue's comments to discuss them 😉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Ready
Development

No branches or pull requests

1 participant