Update Scalatra's default value (#403)

* update scalatra default value

* minor rupdate to template
This commit is contained in:
William Cheng 2018-05-10 10:56:11 +08:00 committed by GitHub
parent 27c372ff56
commit 868ede53f9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
17 changed files with 34 additions and 35 deletions

View File

@ -44,8 +44,9 @@ public class ScalatraServerCodegen extends AbstractScalaCodegen implements Codeg
modelTemplateFiles.put("model.mustache", ".scala"); modelTemplateFiles.put("model.mustache", ".scala");
apiTemplateFiles.put("api.mustache", ".scala"); apiTemplateFiles.put("api.mustache", ".scala");
embeddedTemplateDir = templateDir = "scalatra"; embeddedTemplateDir = templateDir = "scalatra";
apiPackage = "io.swagger.server.api"; invokerPackage = "org.openapitools";
modelPackage = "io.swagger.server.model"; apiPackage = "org.openapitools.server.api";
modelPackage = "org.openapitools.server.model";
setReservedWordsLowerCase( setReservedWordsLowerCase(
Arrays.asList( Arrays.asList(
@ -80,9 +81,7 @@ public class ScalatraServerCodegen extends AbstractScalaCodegen implements Codeg
typeMapping.put("integer", "Int"); typeMapping.put("integer", "Int");
typeMapping.put("long", "Long"); typeMapping.put("long", "Long");
//TODO binary should be mapped to byte array typeMapping.put("binary", "File");
// mapped to String as a workaround
typeMapping.put("binary", "String");
additionalProperties.put("appName", "OpenAPI Sample"); additionalProperties.put("appName", "OpenAPI Sample");
additionalProperties.put("appDescription", "A sample openapi server"); additionalProperties.put("appDescription", "A sample openapi server");

View File

@ -1,12 +1,12 @@
{{>licenseInfo}} {{>licenseInfo}}
import {{apiPackage}}._ import {{apiPackage}}._
import io.swagger.app.{ ResourcesApp, SwaggerApp } import {{invokerPackage}}.app.{ ResourcesApp, OpenAPIApp }
import javax.servlet.ServletContext import javax.servlet.ServletContext
import org.scalatra.LifeCycle import org.scalatra.LifeCycle
class ScalatraBootstrap extends LifeCycle { class ScalatraBootstrap extends LifeCycle {
implicit val swagger = new SwaggerApp implicit val openapi = new OpenAPIApp
override def init(context: ServletContext) { override def init(context: ServletContext) {
try { try {

View File

@ -1,22 +1,22 @@
{{>licenseInfo}} {{>licenseInfo}}
package io.swagger.app package {{invokerPackage}}.app
import org.scalatra.swagger.{ ApiInfo, SwaggerWithAuth, Swagger } import org.scalatra.swagger.{ ApiInfo, SwaggerWithAuth, Swagger }
import org.scalatra.swagger.{ JacksonSwaggerBase, Swagger } import org.scalatra.swagger.{ JacksonSwaggerBase, Swagger }
import org.scalatra.ScalatraServlet import org.scalatra.ScalatraServlet
import org.json4s.{ DefaultFormats, Formats } import org.json4s.{ DefaultFormats, Formats }
class ResourcesApp(implicit protected val swagger: SwaggerApp) class ResourcesApp(implicit protected val swagger: OpenAPIApp)
extends ScalatraServlet with JacksonSwaggerBase { extends ScalatraServlet with JacksonSwaggerBase {
before() { before() {
response.headers += ("Access-Control-Allow-Origin" -> "*") response.headers += ("Access-Control-Allow-Origin" -> "*")
} }
} }
class SwaggerApp extends Swagger(apiInfo = ApiSwagger.apiInfo, apiVersion = "1.0", swaggerVersion = Swagger.SpecVersion) class OpenAPIApp extends Swagger(apiInfo = OpenAPIInfo.apiInfo, apiVersion = "1.0", swaggerVersion = Swagger.SpecVersion)
object ApiSwagger { object OpenAPIInfo {
val apiInfo = ApiInfo( val apiInfo = ApiInfo(
"""{{{appName}}}""", """{{{appName}}}""",
"""{{{appDescription}}}""", """{{{appDescription}}}""",

View File

@ -32,12 +32,12 @@ class {{classname}}(implicit val swagger: Swagger) extends ScalatraServlet
{{#operation}} {{#operation}}
{{newline}} {{newline}}
val {{nickname}}Operation = (apiOperation[{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}Unit{{/returnType}}]("{{nickname}}") val {{operationId}}Operation = (apiOperation[{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}Unit{{/returnType}}]("{{operationId}}")
summary "{{{summary}}}" summary "{{{summary}}}"
parameters({{#allParams}}{{>queryParam}}{{>pathParam}}{{>bodyParam}}{{>formParam}}{{>headerParam}}{{#hasMore}}, {{/hasMore}}{{/allParams}}) parameters({{#allParams}}{{>queryParam}}{{>pathParam}}{{>bodyParam}}{{>formParam}}{{>headerParam}}{{#hasMore}}, {{/hasMore}}{{/allParams}})
) )
{{httpMethod}}("{{{vendorExtensions.x-scalatra-path}}}", operation({{nickname}}Operation)) { {{httpMethod}}("{{{vendorExtensions.x-scalatra-path}}}", operation({{operationId}}Operation)) {
{{#allParams}} {{#allParams}}
{{#isFile}} {{#isFile}}
val {{paramName}} = fileParams("{{paramName}}") val {{paramName}} = fileParams("{{paramName}}")

View File

@ -1,4 +1,4 @@
organization := "io.swagger" organization := "org.openapitools"
name := "scalatra-sample" name := "scalatra-sample"
version := "0.1.0-SNAPSHOT" version := "0.1.0-SNAPSHOT"
scalaVersion := "2.12.4" scalaVersion := "2.12.4"

View File

@ -1,4 +1,4 @@
organization := "io.swagger" organization := "org.openapitools"
name := "scalatra-sample" name := "scalatra-sample"
version := "0.1.0-SNAPSHOT" version := "0.1.0-SNAPSHOT"
scalaVersion := "2.12.4" scalaVersion := "2.12.4"

View File

@ -10,13 +10,13 @@
*/ */
import io.swagger.server.api._ import org.openapitools.server.api._
import io.swagger.app.{ ResourcesApp, SwaggerApp } import org.openapitools.app.{ ResourcesApp, OpenAPIApp }
import javax.servlet.ServletContext import javax.servlet.ServletContext
import org.scalatra.LifeCycle import org.scalatra.LifeCycle
class ScalatraBootstrap extends LifeCycle { class ScalatraBootstrap extends LifeCycle {
implicit val swagger = new SwaggerApp implicit val openapi = new OpenAPIApp
override def init(context: ServletContext) { override def init(context: ServletContext) {
try { try {

View File

@ -10,23 +10,23 @@
*/ */
package io.swagger.app package org.openapitools.app
import org.scalatra.swagger.{ ApiInfo, SwaggerWithAuth, Swagger } import org.scalatra.swagger.{ ApiInfo, SwaggerWithAuth, Swagger }
import org.scalatra.swagger.{ JacksonSwaggerBase, Swagger } import org.scalatra.swagger.{ JacksonSwaggerBase, Swagger }
import org.scalatra.ScalatraServlet import org.scalatra.ScalatraServlet
import org.json4s.{ DefaultFormats, Formats } import org.json4s.{ DefaultFormats, Formats }
class ResourcesApp(implicit protected val swagger: SwaggerApp) class ResourcesApp(implicit protected val swagger: OpenAPIApp)
extends ScalatraServlet with JacksonSwaggerBase { extends ScalatraServlet with JacksonSwaggerBase {
before() { before() {
response.headers += ("Access-Control-Allow-Origin" -> "*") response.headers += ("Access-Control-Allow-Origin" -> "*")
} }
} }
class SwaggerApp extends Swagger(apiInfo = ApiSwagger.apiInfo, apiVersion = "1.0", swaggerVersion = Swagger.SpecVersion) class OpenAPIApp extends Swagger(apiInfo = OpenAPIInfo.apiInfo, apiVersion = "1.0", swaggerVersion = Swagger.SpecVersion)
object ApiSwagger { object OpenAPIInfo {
val apiInfo = ApiInfo( val apiInfo = ApiInfo(
"""OpenAPI Petstore""", """OpenAPI Petstore""",
"""This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.""", """This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.""",

View File

@ -10,11 +10,11 @@
*/ */
package io.swagger.server.api package org.openapitools.server.api
import io.swagger.server.model.ApiResponse import org.openapitools.server.model.ApiResponse
import java.io.File import java.io.File
import io.swagger.server.model.Pet import org.openapitools.server.model.Pet
import java.io.File import java.io.File

View File

@ -10,9 +10,9 @@
*/ */
package io.swagger.server.api package org.openapitools.server.api
import io.swagger.server.model.Order import org.openapitools.server.model.Order
import java.io.File import java.io.File

View File

@ -10,9 +10,9 @@
*/ */
package io.swagger.server.api package org.openapitools.server.api
import io.swagger.server.model.User import org.openapitools.server.model.User
import java.io.File import java.io.File

View File

@ -9,7 +9,7 @@
* https://openapi-generator.tech * https://openapi-generator.tech
*/ */
package io.swagger.server.model package org.openapitools.server.model
case class ApiResponse( case class ApiResponse(
code: Option[Int], code: Option[Int],

View File

@ -9,7 +9,7 @@
* https://openapi-generator.tech * https://openapi-generator.tech
*/ */
package io.swagger.server.model package org.openapitools.server.model
case class Category( case class Category(
id: Option[Long], id: Option[Long],

View File

@ -9,7 +9,7 @@
* https://openapi-generator.tech * https://openapi-generator.tech
*/ */
package io.swagger.server.model package org.openapitools.server.model
import java.util.Date import java.util.Date
case class Order( case class Order(

View File

@ -9,7 +9,7 @@
* https://openapi-generator.tech * https://openapi-generator.tech
*/ */
package io.swagger.server.model package org.openapitools.server.model
case class Pet( case class Pet(
id: Option[Long], id: Option[Long],

View File

@ -9,7 +9,7 @@
* https://openapi-generator.tech * https://openapi-generator.tech
*/ */
package io.swagger.server.model package org.openapitools.server.model
case class Tag( case class Tag(
id: Option[Long], id: Option[Long],

View File

@ -9,7 +9,7 @@
* https://openapi-generator.tech * https://openapi-generator.tech
*/ */
package io.swagger.server.model package org.openapitools.server.model
case class User( case class User(
id: Option[Long], id: Option[Long],