Help Needed: Expanding Microcks Hub – Enhancing Sandbox & Mocking Capabilities for Key Industry APIs

[vickybesra]

Hello Microcks Community!

I'm Vicky, and I’m excited to introduce myself as an LFX mentee to work on this project and be part of the Microcks Community. I will be focusing on enhancing Sandbox & Mocking Capabilities for Key Industry APIs. This initiative is designed to help developers test and prototype integrations with popular APIs using Microcks.

Project Objectives:

Based on discussions with project maintainers, we've pinpointed several key areas where enhancing our sandbox and API mocks will greatly benefit our community.

Update and Refresh the Existing Sandbox:

• Improve the sandbox environment provided by Microcks Hub for existing mock APIs.
• Ensure compliance with the latest versions of existing APIs.
• Enhance documentation, usability, and deployment mechanisms.

Add New Hub Entries for Key Industry APIs:

• Develop mock entries for leading APIs like GitHub, Twilio, Stripe, or Salesforce and more.
• Ensure the mocks cover essential endpoints and realistic request-response pairs.
• Provide detailed examples and use cases to support integration testing.

Community Contribution Needed!

This project is built around community collaboration, so I invite all adopters to share their feedback on the following key aspects:

1. Which aspects should we tackle first?
2. Should we remove the outdated version and add the latest version?
3. If you’ve worked with any of these APIs (e.g., GitHub, Twilio, Stripe, Salesforce), please share your insights and best practices.
4. Do you have tips or best practices to share for creating realistic API examples or effective dispatcher rules?
5. Would you be interested in contributing to or reviewing any of these initiative?

I'm looking forward to collaborating with you all to make Microcks even better. Your feedback and contributions are greatly appreciated!

[okotdaniel]

Congratulations once again. I would like to contribute to this project

[vickybesra]

Thank you!! I'm excited to collaborate with you and truly appreciate your support!

[yada]

Hi,
Related to this project, can someone test this PR to ensure mocks are still working as expected and provide feedback (comment the PR)?
See: microcks/microcks-quickstarters#24
Thanks

[vickybesra]

How should I test it?
As the contract URL(https://github.com/microcks/microcks-quickstarters/blob/main/oidc/example.com/oidc-1.0-openapi.yaml) is not updated with PR changes, should I create a new URL for the PR changes?

[yada]

You need to check the PR locally so you can give your feedback and validate it before it can be merged, see the magic git commands for this purpose: https://docs.github.com/fr/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally

[vickybesra]

hello @yada,
I have tested it with Postman; the example responses are working fine. Do I need to test Yaml with real-world scenarios?

[yada]

Thanks for the feedback. It's fine as it is a mock. Can you write a comment and say it is fine with you here: microcks/microcks-quickstarters#24

[vickybesra]

sure