Add REST API tools: client library, auth filter, validation, and tests#6
Open
devin-ai-integration[bot] wants to merge 1 commit into
Open
Add REST API tools: client library, auth filter, validation, and tests#6devin-ai-integration[bot] wants to merge 1 commit into
devin-ai-integration[bot] wants to merge 1 commit into
Conversation
- Add reusable PetStoreClient with typed responses and builder config - Add ApiKeyAuthFilter for API key and Bearer token authentication - Add RequestValidator with validation for Pet, Order, User models - Add comprehensive test suite (74 tests) covering all controllers, validation logic, client configuration, and security - Add API_TOOLS.md documentation with usage examples and curl commands - Add test dependencies (JUnit 4.13.2, Mockito 4.11.0, Servlet API)
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
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.
Summary
Adds a complete set of reusable REST API tools to the petstore project:
1. REST API Client (
io.swagger.petstore.client)PetStoreClient— typed HTTP client wrapping all petstore endpoints (Pet, Store, User CRUD) with built-in API key auth, configurable timeouts, andApiResponse<T>wrapper for status/body inspectionApiClientConfig— builder-pattern configuration for base URL, API key, timeouts2. Authentication/Authorization (
io.swagger.petstore.security)ApiKeyAuthFilter— servlet filter validatingapi_keyheader,Authorization: Bearer, or query param; skips public endpoints (login, logout, openapi spec, OPTIONS)ApiKeyStore— singleton in-memory key registry (production: swap for DB lookup)SecurityContext— models OAuth2 scopes (read:pets,write:pets) for future use3. Request Validation (
io.swagger.petstore.validation)RequestValidator— static validators for Pet (name required, status enum, photoUrls non-empty), Order (petId > 0, quantity > 0, status enum), User (username required, email/phone format)ValidationResult— immutable error list withisValid(),getErrorMessage()4. Tests — 74 unit tests across controllers, validation, client config, and security (JUnit 4 + Mockito)
5. Documentation —
docs/API_TOOLS.mdwith usage examples, curl commands, and architecture overviewDependencies added (pom.xml): JUnit 4.13.2 (test), Mockito 4.11.0 (test), javax.servlet-api 3.1.0 (provided)
Link to Devin session: https://partner-workshops.devinenterprise.com/sessions/c056fa75403a48eb86b94db3429c5598