rego

README

Regolith (ReGo): The Foundation for Simplified Multi-Service API Interactions

Regolith, or ReGo, is an open-source Go-based application built to serve as a blanket layer over your API workflows, simplifying interactions with multiple REST APIs from various services like Okta, Google, Atlassian, and more. The term Regolith combines two Greek words: rhegos (ῥῆγος), 'blanket', and lithos (λίθος), 'rock'. ReGo provides a robust foundation for inter-service operations with dedicated service clients and helper functions.

---

Why ReGo?

Working with multiple REST APIs, each with their unique specifics, can be challenging. ReGo addresses this complexity by establishing a solid, maintainable foundation for managing these interactions. Much like the geological regolith provides a base for celestial bodies, our Regolith creates a structured package for each service along with common helper functionalities, simplifying your inter-service operations and API workflows.

---

Main Features

• Service-specific clients: Dedicated clients for each service streamline HTTP requests and JSON handling into detailed entities.
• Automated Documentation: Leverages gomarkdoc to automatically transform code comments into Markdown documentation.
• Common Helper Functions: Common helper functionalities enhance code reusability and maintainability.
• Universally Applicable Code: The code doesn't rely on any company-specific logic, making it usable by any individual or company interacting with the services.
• Foundation for Compliance-as-Code: While initially conceived to streamline/solve internal challenges, the codebase is versatile enough to lay the groundwork for initiatives such as compliance-as-code.

---

Open Source and License

ReGo is open source and licensed under the Apache License 2.0, allowing its use, distribution, modification, and the distribution of modified versions under the terms stipulated in the license.

Start your journey with ReGo today, and transform the way you manage your multi-service API interactions!

---

Work in Progress Disclaimer

Please note that Regolith (ReGo) is currently under heavy active development. While we strive to maintain the highest level of quality and stability, certain features and functionalities are still being refined and may not work perfectly. Feedback, suggestions, and contributions are always welcome and highly appreciated.

If you encounter any issues or have ideas for improvements, please don't hesitate to submit them via the project's issue tracker. Your understanding and patience are greatly appreciated as we work towards making Regolith the best it can be!

Documentation

Overview

cmd/main.go