search

ontoportal / documentation

Source code for OntoPortal user, admin and developer guides
https://ontoportal.github.io/documentation
BSD 2-Clause "Simplified" License
3 stars 9 forks source link

Contributing sample OpenAPI Specification #46

Open chris-day opened 1 year ago

chris-day commented 1 year ago

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 commented 1 year ago

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 commented 1 year ago

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