Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/darkredz/zeko-restapi-examples
Example project using Zeko Rest API framework
https://github.com/darkredz/zeko-restapi-examples
kotlin kotlin-coroutines microservice mvc-framework rest-api vertx vertx-web zeko zeko-data-mapper zeko-restapi zeko-sql-builder
Last synced: 22 days ago
JSON representation
Example project using Zeko Rest API framework
- Host: GitHub
- URL: https://github.com/darkredz/zeko-restapi-examples
- Owner: darkredz
- License: apache-2.0
- Created: 2020-04-28T19:32:11.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-02-10T03:28:33.000Z (almost 2 years ago)
- Last Synced: 2024-10-10T20:54:05.378Z (about 1 month ago)
- Topics: kotlin, kotlin-coroutines, microservice, mvc-framework, rest-api, vertx, vertx-web, zeko, zeko-data-mapper, zeko-restapi, zeko-sql-builder
- Language: Kotlin
- Size: 246 KB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Zeko Rest API Example Project
Example project in Kotlin language using [Zeko Rest API framework](https://github.com/darkredz/zeko-restapi-framework)
## Getting Started
Clone the project, cd to the folder.
Run the shell script to start the RESTful backend in development mode(hot reload enabled)
```shell script
./run.sh
```
Open browser and go to http://localhost:9999
Now, you should be able to test your API endpoints now with browser, [Postman](https://www.postman.com) or tool of your choice
After running app is compiled, you will also find swagger.json under api-doc folder.
Just import it into Postman and start playing around
To build a docker image execute the shell script which will build the image to your docker daemon
```shell script
./build-docker-image.sh
```
## Project Creator
Zeko Rest API framework has built-in project creator feature since 1.0.7.
Try to create a new project barebone by calling the endpoint [/project/create](https://github.com/darkredz/zeko-restapi-examples/blob/master/src/main/kotlin/io/zeko/restapi/example/controller/ProjectCreatorController.kt) in this project.
Simply send a post/get request to the endpoint using Postman, browser or wget and download the project zip file.
## Brief Explanation
You should import the database [zeko_test.sql](https://github.com/darkredz/zeko-restapi-examples/blob/master/zeko_test.sql) into your MySQL server for the demo to work.
This projects uses [Koin](https://insert-koin.io/) for dependency injection.
[BootstrapVerticle](https://github.com/darkredz/zeko-restapi-examples/blob/master/src/main/kotlin/io/zeko/restapi/example/BootstrapVerticle.kt) is the main entry file and all dependencies needed are created here.
[Jackson](https://github.com/FasterXML/jackson) is set to use snake case naming strategy when encoding JSON.
It is also set to convert date objects to ISO date time string.
Example usage of [SendGrid](https://sendgrid.com/) mail service can be found under user registration, which sends email in a circuit breaker strategy.
You can uncomment/comment the code in the bootstrap class to switch to [Mandrill](https://mandrillapp.com/)
[RestApiVerticle](https://github.com/darkredz/zeko-restapi-examples/blob/master/src/main/kotlin/io/zeko/restapi/example/RestApiVerticle.kt) contains all the routes and cronjobs of the project.
You will find error handler, JWT auth and token refresh here.
SQL queries are executed with [Jasync](https://github.com/jasync-sql/jasync-sql) async MySQL driver,
however you can change to use [Hikari-CP](https://github.com/brettwooldridge/HikariCP) or [Vert.x JDBC client](https://vertx.io/docs/vertx-jdbc-client/kotlin/) in [DB class](https://github.com/darkredz/zeko-restapi-examples/blob/master/src/main/kotlin/io/zeko/restapi/example/DB.kt)