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

Make OpenAPI docs from RestXQ annotations #82

Open
dvglc opened this issue Feb 18, 2020 · 1 comment
Open

Make OpenAPI docs from RestXQ annotations #82

dvglc opened this issue Feb 18, 2020 · 1 comment
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@dvglc
Copy link
Contributor

dvglc commented Feb 18, 2020

For instance, using https://lab.sub.uni-goettingen.de/openapi4restxq.html (I haven't managed to get this to work reasonably fast, though...). There might be other tools available as well.

Once available, the API default handler could redirect to the OpenAPI docs in case of an underspecified request (instead of throwing an 400 error, as is the case ATM).

@dvglc dvglc added the enhancement New feature or request label Feb 18, 2020
@dvglc dvglc added this to the v2.0 milestone Feb 18, 2020
@dvglc
Copy link
Contributor Author

dvglc commented Mar 3, 2020

Perhaps the easiest way for generating OpenAPI docs would be a self-written program for transforming the output of a restxq registry function (such as exrest:register-module()) into an OpenAPI-json format. See the output of $config:app-root/register-rest.xql, for example.

@dvglc dvglc modified the milestones: v2.0, v2.1 Mar 3, 2020
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