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
0
votes
1 answer

Exclude certain response model fields from Enunciate docs

Problem: I have some java models being used both for request and response body on some endpoints. The thing is, on a specific request, I don't want to show all fields from that model; also, on the response, maybe I want to show completely different…
Bogdan Zurac
  • 6,348
  • 11
  • 48
  • 96
0
votes
1 answer

Namespace issues with Enunciate

I have a jax-ws project that is using Enunciate with Maven to build into a war file. When I deploy it to my app-server, I get weird namespace issues when trying to test with SoapUI. The xml request will have the correct namespace prefix for my…
0
votes
1 answer

Object root element missing for JSON object in the docs generated by Enunciate

I am using Enunciate to generate documentation for my REST project. The issue I am having is with the example json object that it generates. While the XML representation is correct, the JSON representation of the same object is missing the root…
Rocky
  • 365
  • 1
  • 5
  • 15
0
votes
1 answer

Enunciate: In my wadl, why do all my resources path attributes get prefixed with "/rest"?

The resource class is defined like this: @Path("v1") @Produces({MediaType.APPLICATION_JSON}) @Consumes({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) public class RestApi { And I have a method defined like…
Daniel Kaplan
  • 62,768
  • 50
  • 234
  • 356
0
votes
1 answer

Error initializing enunciate - generate step error

I have configured my REST/Spring/Jersey project to generate documentation for APIs using enunciate. The relevant changes in my pom.xml are org.codehaus.enunciate
0
votes
2 answers

Is it possible to have a class support both a JAX-RS service and JAX-WS service?

I've created a RESTful web service using jersey and JAX-RS annotations. It's also documented using enunciate and looks great. However, SOAP support has been requested as an option. I noticed in this outdated enunciate example JAX-WS and JAX-RS…
Chip
  • 1,439
  • 3
  • 15
  • 29
0
votes
1 answer

How to change Enunciate class name with a custom String

I am evaluating Enunciate to produce the documentation for a java rest api built with resteasy. How can I change the resource class name with a custom String? The annotation @ResourceLabel can only be applied to methods. Any idea? Thanks, Fabrizio
Fabrizio Fortino
  • 1,479
  • 1
  • 14
  • 22
0
votes
1 answer

Issue Class was explicitly imported, but it was not found on the classpath. We'll try to import it anyway

I trying to import model classes into enunciate docs but I'm getting the following in the Maven log: Class com.mycompany.model.MyClass was explicitly imported, but it was not found on the classpath. We'll try to import it anyway. I'm trying to…
DarVar
  • 16,882
  • 29
  • 97
  • 146
0
votes
1 answer

Where do the source files under /obj-c/target/enunciate/gen/ come from?

I've been working with enunciate on my Mac. Since installing the latest version of the Xcode Command Line Tools, I get compiler errors on enunciate.m and enunciate-common.m. They're pretty basic syntax errors that I was able to solve easily by going…
0
votes
1 answer

Enunciate validation of Jersey API fails with @POST @FormParam + String data

I'm evaluating enunciate to document our REST APIs and I'm having an issue with the validation step: Validation result has errors. my.java: error: [core] An entity parameter must be of type MultivaluedMap if there is another…
TheArchitect
  • 2,161
  • 1
  • 12
  • 16
0
votes
1 answer

Maven deploy enunciate plugin output to a different project

I am currently working with "enunciate" plugin to generate the API documentation for out website. I would like to separate the documentation from the API into different projects that will be deployed together to the same tomcat server as a part of…
Gleeb
  • 10,773
  • 26
  • 92
  • 135
0
votes
1 answer

Enunciate Documentation Modify or Remove "Generated by" Sentence?

When I generate docs using Enunciate at every page it rights that: Generated by Enunciate. Can I modify that string or remove it?
kamaci
  • 72,915
  • 69
  • 228
  • 366
0
votes
1 answer

create an index of all API calls with enunciate

I develop a not-so-RESTful API using Jersey and Jackson. All the API calls are annotated with @Path, @GET/@POST, @Produces and @Consumes. I managed to generate a nice API documentation using enunciate. The question is: Is it possible to tell…
Andrey Vetlugin
  • 960
  • 10
  • 17
0
votes
2 answers

Using Enunciate in multi-module Maven project

I am using Enunciate to generate documentation for RestEasy services inside multi-module Maven project. I have some problems with doc generation when trying to get description of response object atributes. For instance, if my service is defined…
michas
  • 35
  • 1
  • 5
0
votes
1 answer

Enunciate not generating documentation

I am trying to generate enunciate documentation form a mix of classes, all JAX-RS annotated, some coded inn java, some in clojure. I have built a maven project that simply depends on a war file containing the service classes:
mbedoian
  • 41
  • 2