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

Automatically expose documented API based on the defined Operations #863

Open
Martinsos opened this issue Dec 1, 2022 · 6 comments
Open
Labels
enhancement New feature or request hm Requires more thought wow

Comments

@Martinsos
Copy link
Member

We could use Swagger or Openapi for this, or something similar!

It would also make sense to first work more on allowing users to define which API is public, should not change, allow them to customize it, ... , before we let them expose it like this.

@Martinsos
Copy link
Member Author

Btw Rails has an option to print all the routes, maybe that is good first start.

Btw this is also about us promising to not change how routes work without it being a breaking change.

@Martinsos
Copy link
Member Author

Related to #268

@Martinsos Martinsos added enhancement New feature or request wow hm Requires more thought labels Jan 13, 2023
@Martinsos
Copy link
Member Author

@breadchris expressed interest in this.

@Martinsos
Copy link
Member Author

NOTE: We are now using superjson for serializing / deserializing RPC calls, so if we will be exposing them as an API, we need to look into making that work with superjson.

@Martinsos Martinsos changed the title Automatically generated docs for the server API Automatically expose documented API based on the defined Operations Mar 18, 2024
@Martinsos
Copy link
Member Author

Martinsos commented Mar 18, 2024

From some feedback we got, this would help with allowing building mobile and other clients that can then use existing Wasp's backend.

@Martinsos
Copy link
Member Author

Btw they could create their own API by writing their own api declarations and reusing the logic they use in Operations, but that is quite some work and would be much nicer to just be able to get that API for free.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request hm Requires more thought wow
Projects
None yet
Development

No branches or pull requests

1 participant