Add OpenAPI spec configuration options#52
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds user-configurable OpenAPI info metadata (title, description, version) to the Fiber OpenAPI wrapper so generated specs (and auto-served /openapi.json) can reflect application-specific branding/versioning.
Changes:
- Extend
ConfigwithOpenAPITitle,OpenAPIDescription, andOpenAPIVersion, including defaults and merge logic. - Use the new config fields when generating the OpenAPI
infoblock. - Update README and example app usage; add tests covering defaults, overrides, partial overrides, and auto-served spec behavior.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
types.go |
Adds new Config fields for OpenAPI info metadata. |
fiberoapi.go |
Provides defaults, merges new config fields, and injects them into the generated OpenAPI spec. |
config_test.go |
Adds tests validating default/custom/partial OpenAPI info behavior and the auto-served JSON route. |
README.md |
Documents new defaults and shows how to override the OpenAPI info block. |
_examples/simple/main.go |
Demonstrates the new info configuration options in an example. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This file contains hidden or 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
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.
Introduce configuration options for OpenAPI spec title, description, and version, allowing users to customize the generated API documentation. Default values are provided, and tests ensure correct functionality of these features.