feat(webapp): introduce openapi/swagger specification #2425
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- OpenApi/Swagger can be found under: http://localhost:3001/swagger-ui - Redoc can be found under: http://localhost:3001/redoc
luckysori
approved these changes
Apr 16, 2024
Comment on lines
-218
to
-221
| #[serde(with = "bitcoin::amount::serde::as_sat::opt")] | ||
| pub coordinator_reserve: Option<Amount>, | ||
| #[serde(with = "bitcoin::amount::serde::as_sat::opt")] | ||
| pub trader_reserve: Option<Amount>, |
There was a problem hiding this comment.
😞 That's a bit annoying.
There was a problem hiding this comment.
I know :( We could potentially wrap it into another type and then imple ToSchema but I found this was the easiest way.
| let router = Router::new() | ||
| .route("/", get(index_handler)) | ||
| .route("/main.dart.js", get(main_dart_handler)) | ||
| .route("/flutter.js", get(flutter_js)) | ||
| .route("/index.html", get(index_handler)) | ||
| .route("/assets/*file", get(static_handler)) | ||
| .route("/api/version", get(version)) | ||
| .merge(SwaggerUi::new("/swagger-ui").url("/api-docs/openapi.json", ApiDoc::openapi())) | ||
| .merge(Redoc::with_url("/redoc", ApiDoc::openapi())) |
There was a problem hiding this comment.
❓Did you miss /api-docs/ here?
There was a problem hiding this comment.
No, Afaik /swagger-ui needs to find the specification under /api-docs/openapi.json. redocs has its own. We probably only need one of them.
Co-authored-by: Lucas Soriano <lucas@10101.finance>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It is a bit of manual work and boiler plates but once set up it's quite nice.
I've enabled redoc and swagger UI for now but I guess one of them is enough
Note: our authentication seems to be non-standard, and hence, it does not fit to the Swagger authentication. Imho we should fix this to have a fully working swagger client. Supported authentication schemes can be found here
Helps with #2284