Skip to content
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

[FEATURE] Rewrite client with updated dependencies #5

Open
3 tasks
guibranco opened this issue Mar 28, 2023 · 1 comment
Open
3 tasks

[FEATURE] Rewrite client with updated dependencies #5

guibranco opened this issue Mar 28, 2023 · 1 comment
Labels
CI code quality enhancement New feature or request gitauto good first issue Good for newcomers help wanted Extra attention is needed

Comments

@guibranco
Copy link
Owner

guibranco commented Mar 28, 2023

Description:

We need to rewrite the existing REST API client library written in Rust to improve its performance, maintainability, and usability. The new implementation should leverage modern Rust libraries and best practices to ensure robustness and efficiency in API interactions.

Objectives:

  1. Evaluate Existing Code:

    • Review the current implementation of the API client library available at POC-rust-apiclient and apiclient-boilerplate-rs.
    • Identify areas for improvement, such as code structure, error handling, and API request/response management.
  2. Utilize Best Practices:

  3. Choose a Suitable HTTP Client:

    • Select an appropriate HTTP client library for Rust, such as reqwest, ensuring it meets the project's performance and usability requirements.
  4. Implement Features:

    • Implement essential features such as:
      • Making GET, POST, PUT, DELETE requests.
      • Handling JSON serialization/deserialization.
      • Managing errors effectively.
      • Supporting async operations for better performance.
  5. Testing:

    • Write unit and integration tests to validate the functionality of the new client.
    • Consider using WireMock or similar tools for mocking API responses during testing.
  6. Documentation:

    • Update the README and provide clear documentation on how to use the new API client library, including code examples.

Acceptance Criteria:

  • The new REST API client library is implemented using best practices and modern Rust libraries.
  • The library passes all tests and integrates smoothly with the existing codebase.
  • Comprehensive documentation is provided, including usage examples and setup instructions.
@guibranco guibranco added enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers labels Mar 28, 2023
@guibranco guibranco self-assigned this Apr 20, 2023
@guibranco guibranco removed their assignment Jun 30, 2023
@guibranco guibranco changed the title Rewrite client with updated dependencies [FEATURE] Rewrite client with updated dependencies May 15, 2024
@gitauto-ai gitauto-ai bot added the gitauto label Jul 9, 2024
Copy link

gitauto-ai bot commented Jul 9, 2024

@guibranco Pull request completed! Check it out here #24 🚀

Note: I automatically create a pull request for an unassigned and open issue in order from oldest to newest once a day at 00:00 UTC, as long as you have remaining automation usage. Should you have any questions or wish to change settings or limits, please feel free to contact [email protected] or invite us to Slack Connect.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI code quality enhancement New feature or request gitauto good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant