(快速參考)

create-restapi

目的

create-restapi 命令是 Grails 應用程式開發中的一個基本步驟,特別是針對建立設計為 RESTful API 的 Grails 應用程式。呼叫此命令時,會產生一個具有使用者指定名稱的 Grails 應用程式,並將其設定為 REST API。接著,會在執行命令的目錄中建立一個基於所提供應用程式名稱的子目錄。

用法

若要建立 Grails RESTful API,請使用下列命令

$ grails create-restapi [OPTIONS] NAME
  • NAME:具有網頁層的 Grails 外掛程式的所需名稱。

選項

create-restapi 命令接受下列選項

  • NAME:REST API 應用程式的所需名稱。

  • -f, --features=FEATURE[,FEATURE…​]:指定要包含的功能。可用的選項包括 h2、scaffolding、gorm-hibernate5、spring-boot-starter-jetty、springloaded、spring-boot-starter-tomcat、micronaut-http-client、cache-ehcache、hibernate-validator、postgres、mysql、cache、database-migration、grails-gsp、hamcrest、gorm-mongodb、assertj、mockito、spring-boot-starter-undertow、micronaut-inject-groovy、github-workflow-java-ci、jrebel、testcontainers、sqlserver、grails-console、views-markup、asset-pipeline-grails、views-json、gorm-neo4j、asciidoctor、embedded-mongodb、grails-web-console、logbackGroovy、mongo-sync、shade、geb、properties。

  • -g, --gorm=GORM Implementation:指定要設定的 GORM Implementation,選項包括 hibernate、mongodb、neo4j。

  • -h, --help:顯示說明訊息並結束。

  • -i, --inplace:在目前目錄中建立服務。

  • --jdk=<javaVersion>:指定專案的 JDK 版本。

  • -s, --servlet=Servlet Implementation:指定 Servlet Implementation,選項包括 none、tomcat、jetty、undertow。

  • -t, --test=TEST:指定測試架構,選項包括 junit、spock。

這些選項讓您可以根據特定需求和偏好自訂 Grails REST API 應用程式。

範例

以下是一些範例,說明如何使用

  1. 建立名為「bookstore」的 REST API 應用程式

    $ grails create-rest-api bookstore
    $ cd bookstore
  2. 直接在目前目錄中建立 REST API 應用程式

    $ mkdir bookstore
    $ cd bookstore
    $ grails create-rest-api --inplace
  3. 透過新增特定功能自訂 REST API 應用程式(Grails 3.1 之後提供)

    $ grails create-rest-api bookstore --features github-workflow-java-ci,asciidoctor
  4. 建立最小的 Grails REST API 應用程式

    grails create-rest-api minimal-api

    此指令會建立一個名為「minimal-api」的最小的 Grails REST API 應用程式,採用預設設定,非常適合開始新的 REST API 專案。

  5. 建立支援 PostgreSQL 和特定功能的 REST API 應用程式

    grails create-rest-api postgres-api --features postgres

    此指令會產生一個名為「postgres-api」的 Grails REST API 應用程式,設定為使用 PostgreSQL 作為資料庫。它適合開發以 PostgreSQL 作為資料儲存的 REST API。

  6. 建立具有就地開發功能的 REST API 應用程式

    grails create-rest-api inplace-api --inplace

    此指令會在目前目錄中建立一個名為「inplace-api」的 Grails REST API 應用程式,允許就地開發並與現有專案整合。

這些範例展示了使用 create-rest-api 指令建立 Grails REST API 應用程式的各種情況。您可以透過指定功能、資料庫設定和開發選項自訂 REST API 應用程式,以符合專案的特定需求。