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

Contributing sample OpenAPI Specification #46

Open
chris-day opened this issue May 31, 2023 · 2 comments
Open

Contributing sample OpenAPI Specification #46

chris-day opened this issue May 31, 2023 · 2 comments
Labels
enhancement New feature or request

Comments

@chris-day
Copy link

Hi -

I've got an example OpenAPI specification for OntoPortal that I would like to contribute to the project.

Please see attached
OntoPortal-OpenAPI.zip

@syphax-bouazzouni syphax-bouazzouni added the enhancement New feature or request label May 31, 2023
@syphax-bouazzouni
Copy link
Collaborator

Hi @chris-day, thank you very much for this contribution.

image

We wanted to do this since a long time ago, but never find the time to do it.

But do you have any proposition on what would be the best way to deploy this? do we need a specific server or we can integrate it into our current Ruby applications?

@chris-day
Copy link
Author

chris-day commented May 31, 2023

Hi @syphax-bouazzouni, perhaps the easiest way would be to incorporate Swagger UI in the build to present the OpenAPI specification.

(There are better Ruby approaches, but I'm not a Ruby developer - https://medium.com/@sushildamdhere/how-to-document-rest-apis-with-swagger-and-ruby-on-rails-ae4e13177f5d, for example, uses https://github.com/rswag/rswag

and this https://coderwall.com/p/bjk3pa/documenting-rails-based-rest-api-using-swagger-ui

@syphax-bouazzouni syphax-bouazzouni transferred this issue from ontoportal/ontoportal-project Jan 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants