feat: chi /w rest and openapi and zap for logging #117
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
|
🎉 This PR is included in version 1.8.0-next.1 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
swade1987
approved these changes
Jan 12, 2025
BREAKING CHANGE: while this is a template repo and not held to the same expectation of a project that is actually imported, I wanted to call out the major set of changes to the template with this update. - replacing gorilla/mux with chi/rest for openapi generation - replacing logrus with zap - updating to goreleaser@v2
|
🎉 This PR is included in version 2.0.0-next.1 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
ekristen
changed the title
|
🎉 This PR is included in version 2.0.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
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.
Overview
Time to update all the things ...
Breaking Changes
API
Using rest and chi allows for automatic OpenAPI spec generation, this is super beneficial for using with tools like Postman or Scalar. It also allows for automatic client SDK generation!
Build in Docs and Scalar and Swagger UI
Launch the server and then hit http://localhost:4242/api/v1/docs (for the scalar UI) and http://localhost:4242/api/v1/docs/swagger for the swagger UI.