Swagger: Add support for File Content

[willfaught]

I need to be able to embed a swagger.json file into a Go program using the embed package. Config.FileContent enables that.

Summary by CodeRabbit

• New Features
  • Enhanced API documentation capabilities by allowing Swagger file content to be provided directly, in addition to the traditional file path method.
• Tests
  • Added comprehensive tests for new Swagger file handling configurations and multiple API documentation instances.

[coderabbitai]

Walkthrough

The latest update enriches the Swagger middleware by enabling direct input of Swagger file content through FileContent, offering an alternative to FilePath when FileContentis provided. This enhancement ensures that the Swagger file is only read fromFilePathifFileContent` is empty, enhancing flexibility in managing the file.

Changes

File	Change Summary
swagger/swagger.go	Introduced support for supplying Swagger file content directly via FileContent.
swagger/swagger_test.go	Enhanced logic to handle FileContent and expanded test coverage for various configurations.
swagger/README.md	Updated swagger.Config declaration in the README to include FileContent []byte.

A Poem by CodeRabbit

🐇 In the realm of code, where ideas take flight,
📄 A new path emerges, shining bright.
🌟 Swagger evolves with a twist so fine,
🗂️ Content or path, now the choice is thine.
🎉 Celebrate the update, a leap so sly,
🚀 Towards API greatness, we joyfully fly!

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[willfaught]

Synced my fork. Rebased on main.

[gaby]

Overall looks good, reorder the New() and add swagger.json to be used for FileContent testing that's different than the current one.

For example copy the current swagger.json, change the version # and make a new file. Use this file in the test verify the file returned has that version instead of the current one.

[sixcolors]

@willfaught looks open to me....

[gaby]

@willfaught looks open to me....

Different PR, the previous one was closed

[gaby]

LGTM

[gaby]

Ping @gofiber/maintainers

[ReneWerner87]

• documentation missing

[ReneWerner87]

@willfaught can you please add a description for the new feature in the markdown files and maybe an example
otherwise hardly anyone will discover and use the feature

[willfaught]

@ReneWerner87 f0070f2

[coderabbitai]

Actionable comments posted: 1

Out of diff range and nitpick comments (1)

swagger/README.md (1)

118-122: ### Document the precedence of FileContent over FilePath
The documentation for FileContent in the Config structure does not explicitly mention that it takes precedence over FilePath if both are provided. This is a crucial piece of information that can affect how users configure their Swagger middleware. Consider adding a note here to clarify this behavior.