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

add OpenAPI Tester and Documentation tools, powered by OxygenXML Editor #310

Conversation

arturbozieac
Copy link

@arturbozieac arturbozieac commented Mar 8, 2022

Hello, I would like to add OpenAPI tools that our team developed, below I left a short description and hyperlinks to the products.

OpenAPI Tester Tool
The tool provides the ability to execute API requests and validate responses on the fly to ensure that they work as expected. It can be used for OpenAPI files in JSON or YAML format.

OpenAPI Documentation Generator
Oxygen includes an OpenAPI Documentation generator tool that helps you to easily generate full documentation for OpenAPI components in HTML format, including comprehensive annotations and cross references. The documentation displays information about the servers, paths, components and tags defined in the OpenAPI documents. It also includes the JSON schema documentation for the components along with the diagram image for each component generated according to specified options. You can select which components are shown in your output after the OpenAPI documentation is generated.

@AndrewWalsh
Copy link
Collaborator

Hi @arturbozieac ,

Thank you for raising this PR.

A great deal of time has passed since your submission, and there is a merge conflict.

Could you please submit these tools separately? It is difficult to independently identify their core use cases, and usability for members of the OpenAPI ecosystem. In addition, I appreciate much may have changed for your product over the intervening years.

I am also unable to determine a clear path towards verifying the claims of each tool. This also purports to creating two separate PRs, as I'd appreciate the offer of a description in each as to how to use them and validate them.

On those grounds alone, I will close this for now.

However I fully encourage re-submission of these tools as separate PRs, and thank you once again for raising this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants