-
Notifications
You must be signed in to change notification settings - Fork 10
feat: add openapi bootstrap command with best practice examples #28
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
Merged
Conversation
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
Contributor
📊 Test Coverage ReportCurrent Coverage: Coverage Change: ✅ No change Coverage by Package
Generated by GitHub Actions |
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.
Add OpenAPI Bootstrap Command
Overview
This PR introduces a new
openapi bootstrapcommand that generates comprehensive OpenAPI document templates with best practice examples. The command creates a ready-to-use OpenAPI specification that demonstrates proper API design patterns and serves as both a template and learning resource.What's Added
Core Functionality
openapi.Bootstrap()function - Generates a complete OpenAPI 3.1.1 document with best practicesopenapi openapi bootstrap [output-file]commandKey Features
/usersendpoint with proper request/response structureUser,Error), responses, and security schemes$refusage throughout the documentFiles Added
openapi/bootstrap.go- Core Bootstrap function implementationopenapi/bootstrap_test.go- Comprehensive test coverageopenapi/cmd/bootstrap.go- CLI command implementationopenapi/testdata/bootstrap_expected.yaml- Expected output for testingFiles Modified
openapi/cmd/root.go- Added bootstrap command registrationUsage Examples
Testing
Benefits