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
0 answers

enunciate-maven-plugin does not work in Java 11

We have enunciate-maven-plugin from com.webcohesion.enunciate to generate some docs for our api. With Java 8 we did not have any problem but when have upgraded to Java 11 we are having the following error: [WARNING] [ENUNCIATE] [javac] compiler…
Gorka
  • 377
  • 3
  • 14
0
votes
1 answer

ENUNCIATE error: cannot access javax.interceptor.InterceptorBinding

I have a multi module maven project, recenty I added jaxrs-api dependency to one of them. org.jboss.resteasy jaxrs-api 3.0.12.Final ENUNCIATE…
dev1
  • 73
  • 1
  • 8
0
votes
1 answer

XmlJavaTypeAdapter and enunciate?

I'm having a hard time running Enunciate on my project. The project is a multi-module maven project, available from https://svn.opentripplanner.org/trunk . All I want out of enunciate is API docs. Nothing else. We used to have this working via…
novalis
  • 1,112
  • 6
  • 12
0
votes
1 answer

Swagger Annotations with Enunciate

Can Swagger Annotations be used with enunciate and maven. I am trying to add swagger annotations but its not working instead picking up default java doc comments. Tried adding parameters like scan or resourcePackage to swagger tag of enunciate.xml…
Yamini
  • 67
  • 1
  • 6
0
votes
0 answers

Swagger definition errors

Trying to use Swagger on my JAX-RS application with enunciate Maven plugin. The generated JSON definition works well. But when I try to validate it online with Swagger Editor, the converted YAML file has some weird errors. For example: Definition: …
Kishor Prakash
  • 8,011
  • 12
  • 61
  • 92
0
votes
1 answer

Enunciate CXF plugin for JAX-RS

I am attempting to use the Enunciate plugin for CXF to generate documentation for my REST interfaces via the Maven plugin configured as follows: org.codehaus.enunciate
mcobery
  • 19
  • 4
0
votes
1 answer

Would @WebService annotation interfere with @Endpoint in Spring Web Services?

I'm writing a Spring Boot Web Services application, thus I'm using @Endpoint and @PayloadRoot annotations. For documentation purposes I'm using Enunciate, which doesn't support Spring-WS annotatinos at the time of writing. Would it do any harm if I…
watery
  • 5,026
  • 9
  • 52
  • 92
0
votes
1 answer

Enunciate error during invocation when full CRUD is supported in JAX-RS annotated service

I've run into a rather interesting enunciate error: "No more than one JAX-RS entity parameter is allowed (all other parameters must be annotated with one of the JAX-RS resource parameter annotations)." I'm using enunciate to build out both a SOAP…
MaddHacker
  • 1,118
  • 10
  • 17
0
votes
1 answer

Use Enunciate to document an endpoint returning a binary file (image/png)

I am using Enunciate to document a REST service written with spring-webmvc. Some of the endpoints return images. (Please ignore the fact that these images would be better served by another process like nginx or apache webserver.) I'm trying to…
Tim Perry
  • 84
  • 1
  • 11
0
votes
0 answers

Issue with XmlJavaTypeAdapter AndJava XML Client Module of Enunciate

Created DateFormatterAdapter class and applied to date field @XmlAccessorType(XmlAccessType.FIELD) public class Event { @XmlJavaTypeAdapter(DateFormatterAdapter.class) private Date date; private String description; public Date…
Achu
  • 3
  • 2
0
votes
1 answer

Enunciate error: cannot access com.sun.jersey.server.impl.inject.AbstractHttpContextInjectable

We are using enunciate v2.8.0 for generating docs in our project. Also, we use Jersey 2 (org.glassfish.jersey v2.5.1). While building REST module, enunciate maven plugin falls down with error "error: cannot access…
Markiza
  • 444
  • 1
  • 5
  • 18
0
votes
1 answer

Enunciate Spring Request param

I would like to document my Spring api with enunciate. Works fine, but some endpoints have request parameters included. These wont get documented by enunciate. /** * Does some magic. * * @HTTP 201 Successful Request. */ @PostMapping(value =…
Andreas W
  • 225
  • 3
  • 11
0
votes
1 answer

Can Enunciate take Java Interface as data types?

I want to use Enunciate to automatically generate documentation of my REST API. The JAX-RS annotated code goes something like this: @POST @Produces({MediaType.APPLICATION_JSON, MediaType.TEXT_XML}) @Consumes({MediaType.APPLICATION_JSON,…
Ahmad Shahwan
  • 1,662
  • 18
  • 29
0
votes
1 answer

How to have enunciate generate documentation referencing existing xsd

I am using enunciate 2.6.0 to generate documentation for jax-rs services. For 1 method I am using a custom MessageBodyWriter to serialize to xml. I have an xsd file describing the response. Is it possible to point enunciate to that schema doc? By…
Brett Okken
  • 6,210
  • 1
  • 19
  • 25
0
votes
2 answers

Enunciate Documentation - Ignore on a specific field not working

I'm trying to generate enunciate documentation (version 2.3.0). As per the documentation to ignore a specific field on the response sample, we could use either on the following. I have tried using them, but still the documentation creates a sample…
Siva
  • 55
  • 7