Skip to content

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

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

[backend] Add Paperclip to automatically generate OpenAPI v2 specifications for the REST API #231

Closed
TobiasDeBruijn opened this issue Jan 26, 2022 · 3 comments
Labels

Comments

@TobiasDeBruijn
Copy link

Basically as the title says.

The advantage of this would be that an OpenApi V2 specification can be automatically generated from the code. This would be helpful for those implementing client libraries for Torrust. It should be quite trivial to add too, I'd be more than happy to PR this.

Thanks.

@mickvandijke
Copy link
Member

We would certainly appreciate a PR to implement Paperclip :)

@TobiasDeBruijn
Copy link
Author

Awesome.

I'll first need to port Paperclip to support Actix v4, after that it should be easy for Torrust.

@josecelano
Copy link
Member

Is this package the one you would use? We have migrated the backend to Axum and I do not know is it has support for it. And it seems it's not maintained anymore. I'm going to transfer the issue to the backend repo discussion and make it a "feature request" discussion.

@josecelano josecelano transferred this issue from torrust/torrust-index-archive Jun 28, 2023
@torrust torrust locked and limited conversation to collaborators Jun 28, 2023
@josecelano josecelano converted this issue into discussion #232 Jun 28, 2023

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

Labels
Projects
Archived in project
Development

No branches or pull requests

3 participants