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

API documentation with swagger #9

Open
5 tasks
rafacouto opened this issue Mar 7, 2021 · 2 comments
Open
5 tasks

API documentation with swagger #9

rafacouto opened this issue Mar 7, 2021 · 2 comments
Assignees
Milestone

Comments

@rafacouto
Copy link

rafacouto commented Mar 7, 2021

An OpenAPI definition should be generated by the app itself.

Sections to generate:

  • Service information
  • Session management
  • User management
  • Post management
  • Feed management
@rafacouto rafacouto added this to the v1.0 milestone Mar 7, 2021
@rafacouto rafacouto self-assigned this Mar 7, 2021
@EstebanBorai
Copy link
Member

Sounds awesome!

The best approach for this feature is to have Swagger docs generated automatically, so we don't rely on manual work to update the swagger docs as we move forward with this.

Searching the web for a crate to achieve this I've found this crate:

https://crates.io/crates/cargo-swagg

I think we could start this way perhaps?

If you have any other suggestions please share them here so we have more options to accomplish this

@rafacouto rafacouto linked a pull request Mar 8, 2021 that will close this issue
@rafacouto
Copy link
Author

I've tested codegen from swagger to rust and it generates the stub of structs and the skeleton. But I see cargo-swagg more convenient to generate the actix skeleton. BTW, #10 contains a draft with 4 endpoints based on the API definition on README.md to test these or other proposed tools.

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

Successfully merging a pull request may close this issue.

2 participants