-
Notifications
You must be signed in to change notification settings - Fork 0
Feat: Add OpenAPI YAML support and configuration updates #11
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR introduces OpenAPI YAML specification support alongside the existing JSON format, enhancing the API documentation capabilities of the fiber-oapi library. The implementation adds comprehensive YAML support throughout the codebase while maintaining backward compatibility.
- Adds OpenAPI YAML endpoint configuration and generation functionality
- Updates dependency management to include yaml.v3 as a direct dependency
- Extends authentication middleware to exclude YAML endpoints from authentication requirements
Reviewed Changes
Copilot reviewed 9 out of 10 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| types.go | Adds OpenAPIYamlPath field to Config struct for YAML endpoint configuration |
| go.mod | Promotes yaml.v3 from indirect to direct dependency |
| fiberoapi.go | Implements YAML spec generation and routing with proper content-type handling |
| docs_test.go | Extends test configuration to include YAML path testing |
| docs.go | Adds YamlPath field to DocConfig struct for documentation configuration |
| conditional_auth.go | Updates authentication middleware to exclude YAML endpoints |
| _examples/simple/main.go | Demonstrates YAML configuration in example application |
| _examples/simple/go.mod | Updates example dependencies for consistency |
| README.md | Documents the new YAML configuration option |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
…0, and crypto/sys/text to latest versions
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
Copilot reviewed 9 out of 11 changed files in this pull request and generated no new comments.
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Introduce OpenAPI YAML path configuration and support in the application, enhancing documentation capabilities. Update dependencies and include relevant documentation in README.