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 support (or example) auto-generation OpenAPI + SwaggerUI or alternatives #250

Open
dayvejones opened this issue Nov 19, 2023 · 2 comments

Comments

@dayvejones
Copy link

Hello!

Almost any API needs good documentation.

Is it possible to add support auto-generation OpenApi documentation + any UI (swagger or redoc)?

If it were possible to generate documentation automatically based on handlers signature analysis, that would be really cool. Killer feature.

I tried the crate Utoipa , but it does not have official support Ntex and is not entirely auto-generated: all the descriptions have to be done manually and as a result, the documentation can easily diverge from reality.

Thanks!

@leon3s
Copy link
Member

leon3s commented Dec 13, 2023

Hey, i dont think it is in ntex mindset to have these feature out of the box, you should ask the creator of Utoipa if he agree to make a native ntex integration, and/or make a pull request on the utoipa repository, the code would be fairly similar to actix. As for an example I guess you already so this repository

@dayvejones
Copy link
Author

dayvejones commented Dec 14, 2023

Hey, i dont think it is in ntex mindset to have these feature out of the box, you should ask the creator of Utoipa if he agree to make a native ntex integration, and/or make a pull request on the utoipa repository, the code would be fairly similar to actix. As for an example I guess you already so this repository

Hello! I agree that the possibility of auto creating Openapi documentation is not a need for a web framework. But I think that many developers of web services use this feature when working with other technologies. Maybe exist opportunity to add elegantly example with documentation, it will be gorgeous.

I'll see your repository, thanks

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

No branches or pull requests

2 participants