Questions tagged [enunciate]

Enunciate is an engine for dramatically enhancing your Java Web service API.

Enunciate is a tool that can be used to automatically generate REST documentation by using JAX-RS and javadoc annotations. This can be integrated with build technologies such as ant, maven, and gradle.

140 questions
1
vote
2 answers

restful post with additional url parameters?

I have a web service which consumes a json request and outputs a json response. I have an issue where the customer needs to send an additional parameter in the url that can't be in the json body. Is there a way to do that? For example, here is the…
user3217883
  • 1,216
  • 4
  • 38
  • 65
1
vote
0 answers

Enunciate Json Generated Filename

I have several same name data types in my code in different namespaces. When generating the XML Enunciate names these files as xml_namespaceID_datatype.xml this works correctly. Unfortunately the JSON files generated are named as json_datatype.json…
Revive
  • 2,248
  • 1
  • 16
  • 23
1
vote
1 answer

How to document a metro based JAX-WS application

I've developed some JAX-WS web services using the Metro implementation. Now what I want to add to these web services is somehow documentation. Metro, itself, generates you a "simple" doc html file, which includes the location of the WSDL and…
joninx
  • 1,775
  • 6
  • 31
  • 59
1
vote
1 answer

Apache CXF -Enunciate wsdl generation Error

We are using Apache CXF code-first approach to create web-services. We have a custom soap header to pass user credentials. I am trying to pass the usercredentials in the SEI using a @webparam annotation. These are two operations in the Service…
vijay
  • 11
  • 2
1
vote
2 answers

Defining Courier font in Java Documentation comments

In my Enunciate API documentation report, I need to change the font of some comment text to "Courier New" font type. Is is possible?
Srikanth Balaji
  • 2,638
  • 4
  • 18
  • 31
1
vote
1 answer

After the codehaus closure what the new location for : http://enunciate.codehaus.org/schemas/enunciate-1.27.xsd ?

We have some XML file that refer to 'http://enunciate.codehaus.org/schemas/enunciate-1.27.xsd', which is now gone. Current sub I am using …
Ajeet Ganga
  • 8,353
  • 10
  • 56
  • 79
1
vote
1 answer

How can I generate Enunciate documentation in a gradle build

Enunciate currently does not have a gradle plugin (https://jira.codehaus.org/browse/ENUNCIATE-815). Is there any way to trigger a build of the docs from Gradle manually?
Phyxx
  • 15,730
  • 13
  • 73
  • 112
1
vote
1 answer

Enunciate with Swagger - cannot generate documentation resource models when using generics

I'm facing similar issue than the one described in that thread : Can Enunciate generate docs for an API that handles generic types? I am using enunciate 1.28 with spring and swagger modules enabled. So considering an abstract resource class like…
kochouloo
  • 11
  • 3
1
vote
0 answers

How to generate REST API Documentation using enunciate through ANT Build Tool?

My first assignment at work is to do an enunciate build to generate Rest API Documentation. I am using Ant Build Tool. I am applying enunciate on one of our modules called xmbo. I am encountering an error: java.util.zip.ZipException: ZIP file must…
1
vote
1 answer

Deactivate XML examples and XML documentation in enunciate

I have a REST service that is documented using enunciate. None of my endpoints provide application/xml output. Still I get documentation similar to here: http://enunciate.codehaus.org/wannabecool/step4/el_persona_persona.html (example XML) and here:…
Shirky
  • 347
  • 2
  • 3
  • 14
1
vote
1 answer

Enunciate validation failing

I'm getting the following error while running mvn -e enunciate:docs on a project: error: [core] java.lang.StackTraceElement: A TypeDefinition must have a no-arg constructor or be annotated with a factory method. [ERROR] Failed to execute goal…
Osiris
  • 4,195
  • 2
  • 22
  • 52
1
vote
1 answer

Maven enunciate error: "String index out of range: 0"

When I build my Maven project or generate my eclipse configuration using mvn eclipse:eclipse, I get the following error: [ERROR] Failed to execute goal org.codehaus.enunciate:maven-enunciate-plugin:1.28:docs (default) on project appserver-server:…
Corey Wu
  • 1,209
  • 1
  • 22
  • 39
1
vote
1 answer

How can we generate wadl using enunciate

I would like to generate wadl using enunciate. What configuration changes I need to do for that ? As per http://jira.codehaus.org/browse/ENUNCIATE-688, the enunicate seems to have support for wadl generation. Thanks
White Roses
  • 309
  • 1
  • 6
  • 16
1
vote
1 answer

Java doc missing for inherited method in enunciate

I have following class hierarchy. When I generate javadoc for subclass, the generated doc does not contain java doc comment for the method inherited from the super class. public class SuperClass { /** Something interesting. */ public void…
White Roses
  • 309
  • 1
  • 6
  • 16
1
vote
1 answer

PathParam and FormDataParam

PathParam and FormDataParam are used within REST API but the docs from enunciate indicates 'path' for PathParam and 'formdata' for FormDataParam ? I have include pattern="com.sun.jersey.multipart.FormDataParam" include…
derek
  • 51
  • 3
  • 6