Merge pull request #51 from shinusuresh/update_api_spec_0.23.0

Generate model files as part of build process. Changes forked from PR #27

Author: kishorenc

CONTRIBUTING.md

@@ -9,29 +9,6 @@ Please note we have a code of conduct, please follow it in all your interactions
 
 Before making a PR to this repository look out for the following guidelines.
 
-## Guidelines for updating the client
-
-- Head over to [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) and download the cli jar.
-- Download the latest api spec for typesense server from [typesense-api-spec](https://github.com/typesense/typesense-api-spec)
-- Create a new `config.json` and add the following content
-  ```json
-  {
-    "modelPackage" : "org.typesense.model",
-    "apiPackage" : "org.typesense.api"
-  }
-  ```
-- Run the following command:
-  ```bash
-  java --add-opens java.base/java.util=ALL-UNNAMED --add-opens java.base/java.net=ALL-UNNAMED \
-  --add-opens java.base/java.lang.reflect=ALL-UNNAMED --add-opens java.base/java.text=ALL-UNNAMED \
-  --add-opens java.desktop/java.awt.font=ALL-UNNAMED -jar ~/apps/swagger-codegen-cli-3.0.20.jar generate \
-  -i /path/to/typesense-api-spec/openapi.yml -l jaxrs-cxf-client -c config.json -o /tmp/model
-  ```
-- Now, copy the content under ```<out-dir>/src/gen/java/org/typesense/model``` and replace it with the content of the ```typesense-java/src/main/java/org/typesense/model``` folder in the `typesense-java` client repository.
-- And then make the necessary changes in `api` folder.
-
-**NOTE**: The `model` directory is **read-only** make sure not to edit it.
-
 ## Publishing
 
 Publishing requires the presence of a `~/.gradle.properties` file:

build.gradle

@@ -4,8 +4,11 @@ plugins {
     id 'maven-publish'
     id 'io.github.gradle-nexus.publish-plugin' version "${nexusPluginVersion}"
     id 'com.github.johnrengelman.shadow' version "${shadowJarPluginVersion}"
+    id 'org.hidetake.swagger.generator' version '2.19.2'
 }
 
+apply plugin: DownloadSpecsPlugin
+
 repositories {
     mavenCentral()
 }
@@ -62,6 +65,7 @@ dependencies {
     implementation "io.swagger.core.v3:swagger-annotations:${swaggerCoreV3Version}"
     implementation "org.slf4j:slf4j-api:${slf4jVersion}"
     implementation "com.squareup.okhttp3:okhttp:${okhttp3Version}"
+    implementation group: 'javax.annotation', name: 'javax.annotation-api', version: '1.3.2'
 
     testImplementation "org.junit.jupiter:junit-jupiter-api:${junitJupiterVersion}"
     testImplementation "org.hamcrest:hamcrest-all:${hamcrestVersion}"
@@ -70,12 +74,30 @@ dependencies {
     integrationTestImplementation "org.junit.jupiter:junit-jupiter-api:${junitJupiterVersion}"
     integrationTestImplementation "org.hamcrest:hamcrest-all:${hamcrestVersion}"
     integrationTestRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:${junitJupiterVersion}"
+
+    swaggerCodegen 'io.swagger.codegen.v3:swagger-codegen-cli:3.0.36'
 }
 
 tasks.withType(Test).configureEach {
     useJUnitPlatform()
 }
 
+swaggerSources {
+    typesense {
+        inputFile = file("$buildDir/openapi.yml")
+        code {
+            language = "java"
+            configFile = file("swagger-config.json")
+            components = ['models']
+        }
+    }
+}
+
+swaggerSources.typesense.code.dependsOn downloadApiSpec
+compileJava.dependsOn swaggerSources.typesense.code
+sourceSets.main.java.srcDir "${swaggerSources.typesense.code.outputDir}/src/main/java"
+sourceSets.main.resources.srcDir "${swaggerSources.typesense.code.outputDir}/src/main/resources"
+
 nexusPublishing {
     repositories {
         sonatype {

buildSrc/build.gradle

@@ -0,0 +1,4 @@
+plugins {
+    id 'groovy'
+    id 'groovy-gradle-plugin'
+}

buildSrc/settings.gralde

@@ -0,0 +1,20 @@
+import org.gradle.api.Plugin
+import org.gradle.api.Project
+
+/**
+ * Downloads Typesense API spec from https://github.com/typesense/typesense-api-spec/blob/master/openapi.yml
+ */
+class DownloadSpecsPlugin implements Plugin<Project> {
+
+    def specUrl = 'https://raw.githubusercontent.com/typesense/typesense-api-spec/master/openapi.yml'
+
+    @Override
+    void apply(Project project) {
+        project.tasks.register("downloadApiSpec") {
+            println('Downloading spec')
+            new File("${project.buildDir}/openapi.yml").withOutputStream { out ->
+                new URL(specUrl).withInputStream { from -> out << from }
+            }
+        }
+    }
+}