gleece

README

Gleece - Bringing joy and ease to API development in Go! 🚀

---

Philosophy

Developing APIs doesn’t have to be a chore - it should be simple, efficient, and enjoyable.

Gone are the days of manually writing repetitive boilerplate code or struggling to keep your API documentation in sync with your implementation.

With Gleece, you can:

• ✨ Simplify your API development process.
• 📝 Automatically generate OpenAPI v3.0.0 / v3.1.0 specification directly from your code.
• 🎯 Ensure your APIs are always well-documented and consistent.
• ✅ Validate input data effortlessly to keep your APIs robust and secure.
• 🛡 Security first approach, easy authorization with supplied check function.
• 🧩 Customize behavior to your exact needs by extending or overriding the routes templates.
• ⚡️ Choose Your Framework - seamlessly works with Gin, Echo, Gorilla Mux, Chi, & Fiber Rest frameworks.

Gleece aims to make Go developers’ lives easier by seamlessly integrating API routes, validation, and documentation into a single cohesive workflow.

💫 Look & Feel

Here’s a practical snippet of how Gleece simplifies your API development:

All other aspects, including HTTP routing generation, authorization enforcement, payload validation, error handling, and OpenAPI v3 specification generation, are handled by Gleece.

🪄 How It Works

There's NO magic or hidden underlying hacks at runtime! 😊

Once your API functions are ready, use the Gleece CLI to generate routes according to your chosen engine.

These generated routes work just like any manually written route and need to be registered to your engine's router instance through your application code.

You can continue to use your engine's native calls, middlewares, and other features as before - Gleece's generated code acts only as a complementary plugin to your router.

📚 Documentation

Explore the complete Gleece documentation to get started quickly.

You can also check out the Gleece Example Project, which demonstrates how to set up and use Gleece in a real-world scenario. This hands-on reference will help you integrate Gleece seamlessly.

🎨 VSCode Extension

To enhance your development experience with Gleece, we provide an official VSCode extension that provides intelligent annotation highlighting and improved code visibility.

For more information and capabilities see the Gleece VSCode Extension.

To install it search Gleece in the "Extension" tab or go to the VSCode Marketplace.

💡 Our Initiative

We believe that API development should be code-first, focusing on the developer experience while maintaining industry standards. Coming from the TypeScript ecosystem, we were inspired by frameworks like TSOA that handle everything from routing and validation to OpenAPI generation - all from a single source of truth: your code.

Read more about our initiative and development philosophy in my Gleece Project blog post.

⚠️ Disclaimer

Gleece is currently an under-development project. We’re working hard to make it amazing.

We’d love your feedback and contributions as we shape Gleece!

---

📜 License

Gleece is licensed under the MIT LICENSE.

---