search

vtex / openapi-schemas

OpenAPI 3.0 JSON schemas. Files are automatically synced to the VTEX Developer Portal.
https://developers.vtex.com/docs/api-reference
103 stars 134 forks source link

Esquema Swagger inválido #308

Open gabrielmcf opened 3 years ago

gabrielmcf commented 3 years ago

Tentei gerar um cliente java usando o esquema swagger do Catalog API porém ele é inválido, segundo o Swagger Editor. Mesmo gerando o cliente com o ignore-spec ele fica com vários objetos de retorno e envio com nomes de Example e Request, criando um código muito porco. Se é o esquema oficial das APIs da Vtex poderia pelo menos seguir de verdade o padrão OpenAPI 3. @karenkrieger @brunoamui @JulianaMeyerArruda @brenobarreto @georgebrindeiro @garrucho

gabrielmcf commented 3 years ago

Usei o seguinte comando:

docker-entrypoint.sh generate \
    -c ./vtex-catalog-api-config.json \
    -i ./vtex-catalog-api.json \
    -g java \
    -o ./build-client \
    -t ./src/main/resources/templates/Java \
    --skip-validate-spec

O arquivo vtex-catalog-api-config.json era:

{
  "modelPackage": "br.com.vtexcatalogapi.model",
  "apiPackage": "br.com.vtexcatalogapi.api",
  "invokerPackage": "br.com.vtexcatalogapi",
  "groupId": "br.com",
  "artifactId": "VtexCatalogApi",
  "artifactVersion": "0.0.1",
  "library": "jersey2",
  "hideGenerationTimestamp": true,
  "useRuntimeException": true,
  "fullJavaUtil": true,
  "modelPropertyNaming": "original",
  "typeMappings": {
    "number": "java.lang.Double"
  }
}