47198

Error Generating OpenAPI doc using the endpoint-framework-tools (unclear documentation)

Question:

(Intro)<br /> I am undergoing some tutorials on google cloud endpoint using the google documentation. I have managed to run my first API but i am having an error generating an OpenAPI document using the endpoint-framework-tools

(Question/Issue)<br /> Long story short, I am having an "unclear" error while trying to generate the OpenAPI document of my google cloud endpoint project. Official google docs <a href="https://cloud.google.com/endpoints/docs/frameworks/java/adding-api-management" rel="nofollow">(here)</a> states the below method to generate the file:

endpoints-framework-tools-2.0.0-beta.11/bin/endpoints-framework-tools\ get-openapi-doc \ --hostname=YOUR-PROJECT-ID.appspot.com \ --war=target/echo-1.0-SNAPSHOT \ com.example.echo.Echo

They do not specify what is "com.eample.echo.Echo". Trying to run the command by replacing com.example by my package path I am receiving the below confusing error.

Error: co.mydomain.eliokhattar.myapplication.backend.MyEndpoint

replacing the above package by any other package still gives the same error.

Can any one advise or provide a clear tutorial on how to use this endpoints-framework-tool?

Answer1:

I have figured out the issue, and it was related to the fact that i was not mentionning the -classpath parameter when invoking endpoint framework. The below command worked fine.

endpoints-framework-tools-2.0.0-beta.11/bin/endpoints-framework-tools \ get-openapi-doc \ --hostname=iccloudendpoint.appspot.com \ --war=/Users/eliokhattar/endpints-test/IcExteranlTutorialDemo/icSysBackend/src/main/webapp \ --classpath=/Users/eliokhattar/endpints-test/IcExteranlTutorialDemo/icSysBackend/build/classes/main/ co.mydomain.eliokhattar.myapplication.backend.MyEndpoint

On the other hand i am having a different unrelated error now.

Answer2:

You want the compiled application. You are pointing to your source code. Try something like "icSysBackend/build/exploded-app".

Also, you want the format of the class to be based on where it is in the package. Think "com.etc.etc.Class" not "com/etc/etc/Class".

Recommend

  • How to describe a multipart response using OpenAPI (Swagger)?
  • How to document dynamic query parameter names in OpenAPI (Swagger)?
  • Open api 3.0 mock Generator [closed]
  • why this error is coming i have not even started coding
  • Upgrade from Jenkins Weekly to LTS
  • LDA: Why sampling for inference of a new document?
  • Ansible: setting user on dynamic ec2
  • How to obtain service credentials for a service instance created on IBM Bluemix without binding the
  • Getting a line that has the coordinates defined by the mouse location
  • How to autoplay video in angularjs?
  • Laravel Eloquent integration in Codeigniter
  • How to get to older Xcode beta version?
  • Embedding a Google map
  • How to force Composer to download a local package?
  • Is it possible to send skype chat messages from a linux server without X?
  • jQueryMobile, Ajax Navigation, and MVC
  • Does Apportable support to build library binary (.a/.so)?
  • C# fibonacci function returning errors
  • nodemcu custom firmware build problems
  • Android Studio Can't Find tools.jar
  • Convert SQLite database to XML
  • How to get current document uri in XSLT?
  • Convert Type Decimal to Hex (string) in .NET 3.5
  • Jenkins: FATAL: Could not initialize class hudson.util.ProcessTree$UnixReflection
  • What is the purpose of TaskExecutor in spring?
  • Automatically associate new Sonar project with custom quality profile and quality gate
  • Eclipse CDT error: Unable to compile
  • Zurb Foundation _global.scss meta styles for js?
  • How to run “Deployd” on port 80 instead of port 5000 in webserver.
  • How to attach a node.js readable stream to a Sendgrid email?
  • PostgreSQL Query without WHERE only ORDER BY and LIMIT doesn't use index
  • Switching to Release Build causes runtime error in Web Reference
  • JSON with duplicate key names losing information when parsed
  • Trying to switch camera back to front but getting exception
  • QuartzCore.framework for Mono Develop
  • RestKit - RKRequestDelegate does not exist
  • Free memory of cv::Mat loaded using FileStorage API
  • Angular 2 constructor injection vs direct access
  • Programmatically clearing map cache
  • How to Embed XSL into XML