Error generating raml from jaxrs


#1

Hi,

I have written web services of my Java project using resteasy. For the documentation process i want these web services to be captured using RAML.

For this i followed - https://github.com/mulesoft/raml-for-jax-rs and https://github.com/mulesoft/raml-for-jax-rs/blob/master/maven-plugin.md

In the second link i started the steps for JAX-RS to RAML and followed all the steps.

Instead of using the version 0.0.1-SNAPSHOT or 1.3.4-SNAPSHOT i am using 1.3.3 as i was getting an error using the first two version.
Error -
Failed to read artifact descriptor for org.raml.plugins:jaxrs-raml-maven-plugin:jar:1.3.4-SNAPSHOT: Could not find artifact org.raml:jaxrs-to-raml:pom:1.3.4-SNAPSHOT in Nexus-One (mvn-repo/nexus/content/groups/One) -> [Help 1]

So now using 1.3.3 resolved this but i am getting error of NoSuchMethodError
[ERROR] Failed to execute goal org.raml.plugins:jaxrs-raml-maven-plugin:1.3.3:generate-raml (default) on project spectralight: Execution default of goal org.raml.plugins:jaxrs-raml-maven-plugin:1.3.3:generate-raml failed: An API incompatibility was encountered while executing org.raml.plugins:jaxrs-raml-maven-plugin:1.3.3:generate-raml: java.lang.NoSuchMethodError: com.mulesoft.jaxrs.raml.annotation.model.IParameterModel.getType()Ljava/lang/String;

So i went to check the class file of IParameterModel in com.mulesoft.jaxrs.raml.annotation.model package and it turns out that this interface does not have the method.

Please can anyone specify how to resolve this error and generate raml files for my webservices.


#2

Could you file an issue on the github repo. Therefore, you make sure that the developers being notified. :wink:


#3

Hi ,

Based on the details you have provided it seems you have tried with maven plugin. Could you try with eclipse plugin of ramlforjaxrs utility. It worked fine for me.

Regards
Arun


#4

@arubalac I am able to resolve this issue now. Seems like it was fetching the wrong version.
Using eclipse plugin is much simpler , but my requirement is to build the raml while project packaging.


#5

@rahullao
Just to understand , So your requirement is to generate a raml when your complete the build (packaging) and not an explicit step to generate raml using the eclipse plugin. ?
Is my understanding correct?

Regards
Arun


#6

@arubalac
Yes, our requirement is to automate this process. So we are preferring the maven plugin provided by mulesoft. But facing lot of problem.

For an example we are able to generate raml while packaging but the generated raml does not have schema and example.

I would really appreciate if you can provide some input for http://forums.raml.org/t/incomplete-json-schema-generated-while-generating-raml-using-eclipse-plugin/1085

Thanks