[backend] Add Paperclip to automatically generate OpenAPI v2 specifications for the REST API #232
Replies: 5 comments
-
We would certainly appreciate a PR to implement Paperclip :) |
Beta Was this translation helpful? Give feedback.
-
Awesome. I'll first need to port Paperclip to support Actix v4, after that it should be easy for Torrust. |
Beta Was this translation helpful? Give feedback.
-
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. |
Beta Was this translation helpful? Give feedback.
-
Relates to: https://medium.com/netwo/documenting-api-for-actix-web-b575adb841a1 |
Beta Was this translation helpful? Give feedback.
-
I think we first should discuss whether we need this and if we need it, research about alternatives. |
Beta Was this translation helpful? Give feedback.
-
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.
Beta Was this translation helpful? Give feedback.
All reactions