gleece

KO | EN

gitlite — search

#javascript #ruby #dotfiles #java #php #shell #game #hacktoberfest #c-plus-plus #nodejs #unmaintained #vim

★ 81 Open GitHub ↗

Building, documenting, validating, securing and customizing REST APIs through code-first development

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

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

[![gleece](https://github.com/gopher-fleece/gleece/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/gopher-fleece/gleece/actions/workflows/build.yml)
[![Go Report Card](https://goreportcard.com/badge/github.com/gopher-fleece/gleece)](https://goreportcard.com/report/gopher-fleece/gleece)
[![Coverage Status](https://coveralls.io/repos/github/gopher-fleece/gleece/badge.svg?branch=main)](https://coveralls.io/github/gopher-fleece/gleece?branch=main)
[![Go Version](https://img.shields.io/github/go-mod/go-version/gopher-fleece/gleece)](https://github.com/gopher-fleece/gleece/blob/main/go.mod)

[![VSCode Extension](https://img.shields.io/visual-studio-marketplace/v/haim-kastner.gleece-extension?label=VSCode%20Extension)](https://marketplace.visualstudio.com/items?itemName=haim-kastner.gleece-extension)
<a href="https://docs.gleece.dev">
    <img src="https://img.shields.io/badge/docs-gleece.dev-blue" alt="Documentation">
</a>
[![LibHunt - Gleece](https://img.shields.io/badge/LibHunt-Gleece-blue)](https://www.libhunt.com/r/gleece)
[![Latest Release](https://img.shields.io/github/v/release/gopher-fleece/gleece)](https://github.com/gopher-fleece/gleece/releases)
[![Go Reference](https://pkg.go.dev/badge/github.com/gopher-fleece/gleece.svg)](https://pkg.go.dev/github.com/gopher-fleece/gleece)

[![OpenAPI 3.0](https://img.shields.io/badge/OpenAPI-3.0.0-green.svg)](https://spec.openapis.org/oas/v3.0.0)
[![OpenAPI 3.1](https://img.shields.io/badge/OpenAPI-3.1.0-green.svg)](https://spec.openapis.org/oas/v3.1.0)

[![Gin Support](https://img.shields.io/badge/Gin-Supported-blue)](https://gin-gonic.com/)
[![Echo Support](https://img.shields.io/badge/Echo-Supported-blue)](https://echo.labstack.com/)
[![Gorilla Mux Support](https://img.shields.io/badge/Gorilla_Mux-Supported-blue)](https://github.com/gorilla/mux)
[![Chi Support](https://img.shields.io/badge/Chi-Supported-blue)](https://github.com/go-chi/chi)
[![Fiber Support](https://img.shields.io/badge/Fiber-Supported-blue)](https://github.com/gofiber/fiber)

[![GitHub stars](https://img.shields.io/github/stars/gopher-fleece/gleece.svg?style=social&label=Stars)](https://github.com/gopher-fleece/gleece/stargazers) 
[![License](https://img.shields.io/github/license/gopher-fleece/gleece.svg?style=social)](https://github.com/gopher-fleece/gleece/blob/master/LICENSE)

---

## About  
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 and standardize**  your API development process.  
- Automatically **generate OpenAPI v3.0.0 / v3.1.0** specifications directly from your code.  
- Ensure your APIs are always **up-to-date, well-documented and consistent**.  
- Effortlessly **validate input data** to ensure your APIs are reliable and secure.
- Adopt a **security first** approach with simple yet powerful authorization flows.
- **Customize behavior** to your exact needs by extending or overriding the routes templates.
- Bring your own router - works seamlessly with **Gin, Echo, Gorilla Mux, Chi, & Fiber**.

Gleece aims to make Go developers’ lives easier by seamlessly integrating API routing, validation, and documentation into a single cohesive workflow **without sacrificing performance**.

For more information, check out the [concept](https://docs.gleece.dev/docs/about/concept) section of our documentation

## Documentation

Explore the complete [documentation site](https://docs.gleece.dev/docs/intro) to get started quickly.

You can also check out our [example project](https://github.com/gopher-fleece/gleecexample#readme), which demonstrates how to set up and use Gleece in a real-world scenario. This hands-on reference will help you integrate Gleece seamlessly.

If you've encountered a gap in the documentation or feel some topic is inadequately covered, please let us know via [GitHub Issues](https://github.com/gopher-fleece/gleece/issues)

## Under the hood

*Gleece* is almost exclusively a **design/build time** framework/transpiler- there are no magic tricks or runtime shenanigans.

Once your API implementation is ready, use *Gleece*'s CLI to generate routes according to your chosen engine.

These generated routes work just like any manually written code 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.

For a deeper look into *Gleece*'s internals, please see the [architecture](https://docs.gleece.dev/docs/about/architecture) section of our documentation.

## Look & Feel

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

![Screenshot](https://raw.githubusercontent.com/gophar-fleece/.github/main/docs/screenshots/usage-example.png)

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

## Visual Studio Code Extension

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

For more information and capabilities see the [Gleece VS Code Extension](https://github.com/gopher-fleece/gleece-vscode-extension#readme).

To install it search `Gleece` in the "Extension" tab or go to the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=haim-kastner.gleece-extension).

## 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](https://github.com/lukeautry/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:
* [Haim Kastner's Gleece Project blog post](https://blog.castnet.club/en/blog/gleece-project)

* [A Holistic View on APIs as an Ecosystem](https://zuplo.com/learning-center/holistic-view-of-apis) in *Zuplo*'s learning center

## Security

To report security concerns or vulnerabilities, please follow the instructions in our [Security Policy](./SECURITY.md).

## Contact

For general inquiries or feedback, please reach out to us at [contact@gleece.dev](mailto:contact@gleece.dev).

Anyway, we'd love to hear from you, especially if you or your company use Gleece.

## Help us grow!

*Gleece* is a two-man passion project and requires enormous efforts;

If you find it interesting or useful, please help us grow by dropping a star or telling your colleagues about us!

Your support keeps us going!

---

## License  
Gleece is licensed under the [MIT LICENSE](./LICENSE).

gleece

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README