Git Product home page Git Product logo

igapyon / oiyokan-initializr Goto Github PK

View Code? Open in Web Editor NEW
2.0 2.0 1.0 619 KB

Oiyokan Initializr is a low code tool that quickly publish database tables as a REST API server. Generate Spring Boot web based REST API Server (OData v4) with minimal text input and mouse ops. Knowledge of Spring Boot, Maven, and JDBC settings is recommended.

License: Apache License 2.0

Java 44.54% HTML 40.91% CSS 14.55%
odata odatav4 odata-server spring-boot oiyokan oiyokan-initializr mysql java postgresql oracle-xe

oiyokan-initializr's Introduction

Oiyokan Initializr

Oiyokan Initializr is a low code tool that quickly publish database tables as a REST API server.

  • Generate Spring Boot web based REST API Server (OData v4) with minimal text input and mouse ops.
  • Knowledge of Spring Boot, Maven, and JDBC settings is recommended.

Getting Started with the Oiyokan

Getting Started with the Oiyokan can be viewed at the following URL (written in Japanese).

Usage

Run oiyokan-initializr

1-1. Download the release versoin Source code (zip) of oiyokan-initializr from github.com.

1-2. Extract Source code (zip) to a directory that is convenient for you.

2-1. Build and Run oiyokan-initializr using maven

展開されたディレクトリにディレクトリを移動。 以下の mvn コマンドを実行。

mvn install spring-boot:run

Generate an OData Server using oiyokan-initializr

3-1. 起動後の oiyokan-initializr に Web ブラウザで接続

http://localhost:8082/

3-2. Click START CREATING REST API SERVER FOR RDB

3-3. If basic authentication is shown, login with User: admin, Password: passwd123

3-4. Click ADD DATABASE

3-5. Fill database settings

3-6. Click CONNECTION TEST

3-7. Click APPLY DATABASE SETTINGS

4-1. Click ADD ENTITY

4-2. Select and check Entity(table) you want to publish

4-3. Click APPLY ENTITY SELLECTION

5-1. Click GENERATE REST API SERVER, and you will download an zip file named oiyokan-demo.zip. Note: この手順で生成される oiyokan-demo.zip にはデータベース接続情報の記載を含む oiyokan-settings.json ファイルが含まれます。必要ない場合は手順の後に必ず削除します。

5-2. Oiyokan Initializr を終了。

Run Generated the OData Server

6-1. どこか都合の良いディレクトリで oiyokan-demo.zip を zip展開 ここで展開したファイルの oiyokan-settings.json にはデータベースの接続情報が含まれますので、必要ない場合は手順の後で必ず削除してください。

6-2. zip 展開後のフォルダで以下コマンドにて oiyokan-demo を起動。

mvn install spring-boot:run

6-3. 起動後の oiyokan-demo に Web ブラウザで接続

http://localhost:8080/

ここで起動されているサーバが OData v4 Server (provider) の機能を提供します。

7-1. 試行が終わったら、oiyokan-demo を終了。

7-2. 試行が終わり次第、oiyokan-demo.zip および展開後のファイル oiyokan-settings.json を削除します。 Note: この一連の手順で登場する oiyokan-settings.json ファイルにはデータベース接続情報の記載が含まれます。oiyokan-demo.zip も含めて必要ない場合は手順の後に必ず削除します。

Supported target RDBMS

  • h2 database (1.4)
  • PostgreSQL (13)
  • MySQL (8)
  • SQL Server (2008)
  • Oracle XE (18c)

Supported OData Method

  • GET
  • POST
  • PATCH
  • DELETE

Supported OData system query options

  • $select
  • $count
  • $filter
  • $orderby
  • $top
  • $skip

Oiyokan 関連リポジトリ

oiyokan-initializr's People

Contributors

igapyon avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

Forkers

leismile

oiyokan-initializr's Issues

pom.xmlなど生成時のテンプレート処理が欲しい

pom.xmlなど生成時のテンプレート処理が欲しい
さしあたり oiyokan lib のバージョンが安定するのを見計らってリリースを確実なものにしたい。
Thymeleafのテンプレート処理を利用してpom.xmlを書き換えたい。index.htmlも同様に書き換えたい。

v1.0版のリリース

MySQLのサンプルDBでは不都合が見つかった。
ただし、ワークアラウンドを示した上で、まずは v1.0リリースでも妥当と判断。

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.