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

[fuzon-http] OpenAPI spec integration #21

Open
supermaxiste opened this issue Oct 2, 2024 · 2 comments · May be fixed by #32
Open

[fuzon-http] OpenAPI spec integration #21

supermaxiste opened this issue Oct 2, 2024 · 2 comments · May be fixed by #32
Assignees
Labels
enhancement New feature or request

Comments

@supermaxiste
Copy link
Member

Currently we're following a pretty solid and future-proof API format. In order to further standardize the API and follow best practices, we should follow the OpenAPI specification.

Example libraries that could help in the task:

Note: based on OpenAPI.tools some tools might support different OpenAPI versions, we should watch out and make sure we're supporting the latest.

@supermaxiste supermaxiste added the enhancement New feature or request label Oct 2, 2024
@cmdoret
Copy link
Member

cmdoret commented Dec 16, 2024

apistos looks good as well.

utoipa and apistos both generate OpenAPI v3 docs and support scalar, a modern UI (alternative to swagger) to interactively render openapi docs in the browser.

I think the choice comes down to how easy it will be to integrate either of these with the code.

(paperclip does not support openapi v3)

@cmdoret
Copy link
Member

cmdoret commented Dec 16, 2024

They both have a "simple-todo" example with actix web. At first sight, apistos looks more intuitive:

@cmdoret cmdoret linked a pull request Dec 16, 2024 that will close this issue
@cmdoret cmdoret self-assigned this Dec 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

Successfully merging a pull request may close this issue.

2 participants