(快速参考)

create-restapi

用途

create-restapi 命令是 Grails 应用程序开发中的关键一步,特别是针对创建设计为 RESTful API 的 Grails 应用程序而量身定制。调用该命令后,它将生成具有用户指定名称的 Grails 应用程序,并将其配置为 REST API。随后,它将基于提供应用程序的名称在执行命令的目录中创建一个子目录。

用法

若要创建 Grails RESTful API,请使用以下命令

$ grails create-restapi [OPTIONS] NAME
  • NAME:具有 web 层的 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 Implement:指定要配置的 GORM Implement,选项包括 hibernate、mongodb、neo4j。

  • -h, --help:显示帮助信息并退出。

  • -i, --inplace:在当前目录中创建服务。

  • --jdk=<javaVersion>:指定项目的 JDK 版本。

  • -s, --servlet=Servlet Implement:指定 Servlet Implement,选项包括 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

    此命令将生成一个 Grails REST API 应用程序,名为“postgres-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 应用程序,以满足您的项目的特定要求。