Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ButterCam/sisyphus
Modern gRPC back-end development framework base on JVM.
https://github.com/ButterCam/sisyphus
backend google-aip grpc kotlin protobuf spring-boot
Last synced: 3 months ago
JSON representation
Modern gRPC back-end development framework base on JVM.
- Host: GitHub
- URL: https://github.com/ButterCam/sisyphus
- Owner: ButterCam
- License: mit
- Created: 2020-05-17T05:16:52.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-04-08T21:08:26.000Z (7 months ago)
- Last Synced: 2024-05-15T08:15:52.244Z (6 months ago)
- Topics: backend, google-aip, grpc, kotlin, protobuf, spring-boot
- Language: Kotlin
- Homepage: https://sisyphus.bybutter.com
- Size: 61.8 MB
- Stars: 93
- Watchers: 13
- Forks: 10
- Open Issues: 9
-
Metadata Files:
- Readme: ReadMe.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-grpc - sisyphus - Modern gRPC back-end development framework based on Kotlin/Spring Boot with Message DSL/[HTTP transcoding](https://aip.bybutter.com/127)/[Google AIP](https://aip.bybutter.com) support. (Language-Specific / Kotlin)
README
Sisyphus is the way how we provide backend services. It integrates all tools and libraries needed for designing API
which follows the [Google API Improvement Proposals](https://aip.bybutter.com).
See the [documents](https://sisyphus.bybutter.com/) website for more details,
也包含[中文文档](https://sisyphus.bybutter.com/zh-Hans/)。
## We are rolling a huge boulder
Due to analyzing product documents completely, it is not particularly difficult to write an exquisite and easy-to-use
API at the beginning for most APIs.
However, many people will break the initial design of the API in the endless updates of products.
It's hard to create a strong and extensible API in the whole project lifetime, just like rolling a huge boulder
endlessly up a steep hill.
So we need an all-encompassing guide book to guide us in creating, updating, and modifying APIs.
The [Google API Improvement Proposals](https://aip.bybutter.com) is the all-encompassing guide book. Google created it
in their rich and extensive API design experience. It laid the foundation for anyone to create an extensible API.
## Good tools can help you
Choosing good tools can help you 'rolling a huge boulder' faster and easier. Sisyphus provides and integrates many tools
in your 'boulder rolling' route.
[**Kotlin**](https://kotlinlang.org/) is our target language. The mature JVM community and concise grammar are the
reasons.
[**Spring boot**](https://spring.io/projects/spring-boot) is our old friend to manage and organize our components.
[**gRPC**](https://grpc.io/) is our target API framework. Sisyphus also provides
the [HTTP and gRPC Transcoding](https://aip.bybutter.com/127) component for the environment which isn't compatible with
gRPC.
[**Sisyphus JS**](https://github.com/ButterCam/sisyphus-js) is our customized protobuf and gRPC runtime for Javascript/Typescript.
[**Sisyphus Protobuf**](/lib/sisyphus-protobuf) is our customized protobuf runtime, which designed for Kotlin.
[**Sisyphus gRPC Coroutine**](/lib/sisyphus-grpc) is our customized gRPC stub runtime, which designed for Kotlin coroutine.
[**Sisyphus gRPC RxJava**](/lib/sisyphus-grpc) is our customized gRPC stub runtime, which designed for RxJava2(Client only, design for Android).
[**Sisyphus DTO**](/lib/sisyphus-dto) is the way how we create struct without protobuf.
[**Sisyphus Test**](/lib/sisyphus-test) is the way how we test our gRPC API by data-driven.
[**Sisyphus Middleware**](/middleware) is the way how we connect Sisyphus and other systems.
[**Sisyphus Configuration Artifact**](/middleware/sisyphus-configuration-artifact) is the way how we manage
configurations and developing environment.
[**Sisyphus Kubernetes gRPC client**](/middleware/sisyphus-grpc-client-kubernetes) is the way how we implement service
discovery in Kubernetes.
[**Sisyphus Protobuf Compiler**](/tools/sisyphus-protoc) is the way how we generate Kotlin codes by `.proto` files.
[**Sisyphus Project Plugin**](/tools/sisyphus-project-gradle-plugin) is the way how we manage project and configuring
Gradle.
[**Sisyphus Protobuf Plugin**](/tools/sisyphus-protobuf-gradle-plugin) is the way how we generate code by `.proto` files
in Gradle.
**And More** tools like [CEL(Common Expression Language)](https://github.com/google/cel-spec)
, [Filtering](https://aip.bybutter.com/160) and [Ordering](https://aip.bybutter.com/132#ordering) scripts will help you
to design APIs following Google AIP.