Stack Overflow
Stack Overflow

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

How to document a type in enunciate?

How to get the description field on a type populated in the generated enunciate documentation? We are generating classes from jaxb using jaxb2-maven-plugin. No matter how I document a element either using the …
Peter
  • 5,556
  • 3
  • 23
  • 38
3
votes
1 answer

Swagger - calling a service which returns file does not work properly

I am having a problem similar to the ones described here and here. I have a service which returns a pdf file as attachment with Content-Disposition header. This works when I call the endpoint from the browser - file is downloaded. On Swagger UI I…
Egemen
  • 2,178
  • 5
  • 22
  • 32
3
votes
1 answer

Enunciate not working with Generics

My resource is @GET @Path("/items") public MyCollection getItems()throws Exception{ //Code to return MyCollection } My Item class is @XmlRootElement public class Item{ private int id; private String name; …
Jeevi
  • 2,962
  • 6
  • 39
  • 60
3
votes
2 answers

How to document a Symfony based REST API (similar to enunciate's documentation capabilities)

If I have a REST based service written in the Symfony [symfony-project.org] framework (i.e. PHP), is there any decent tools/frameworks out there that will parse my code and generate API documentation? The Java based framework enunciate has…
Dominic
  • 1,294
  • 1
  • 15
  • 29
3
votes
2 answers

Enunciate Spring annotations API documentation

I am using Enunciate to generate REST API docs in a maven project. The artifact maven-enunciate-plugin generates Web API docs but it ignores Spring annotations like: @Secured (from spring-security) I tried generating docs with maven artifact that…
lihsus
  • 297
  • 3
  • 12
3
votes
2 answers

exclude some jaxb generated classes from enunciate

I am using enunciate and want to exclude certain jaxb generated classes from the documentation. How can this be done? Is it possible to add the org.codehaus.enunciate.XmlTransient annotation via the xsd? Thanks in advance.
ToHe
  • 147
  • 3
  • 13
2
votes
1 answer

Enunciate - How to display media types in the generated REST documents?

I have successfully created the documentation for my endpoints using enunciate. This is a sample from the endpoint: @Produces("application/json") public class Messages { ..... @DocumentationExample("provide an example") …
Alex Dobjanschi
  • 173
  • 1
  • 13
2
votes
1 answer

Using Enunciate with Grails

I am creating Web APIs, in a RESTful manner. Grails of course has good support for creating REST web services. Enunciate claims to help in the API part, where things like documentation, client libraries, etc are important. The purpose of this post…
Gaurav
  • 562
  • 3
  • 12
2
votes
1 answer

Enunciate not can't determine output type for javax.ws.rs.core.Response

I have a REST web service that returns a "javax.ws.rs.core.Response" entity. When I run enunciate, it can't determine the output type, so the response in the generated wadl is left blank: If the code look like…
TERACytE
  • 7,553
  • 13
  • 75
  • 111
2
votes
0 answers

Can I use enunciate module to only display swagger UI?

I have a Java Spring-based RESTful API that uses enunciate for auto-generated documentation. I am upgrading from Enunciate 1.x to 2.8.0, and would like to stop using the base Enunciate documentation in favor of SwaggerUI ONLY. Is there a way to…
Megan D
  • 379
  • 3
  • 13
2
votes
0 answers

Hybrid Automated & Manual rest API documentation using Enunciate

Does Enunciate support the following hybrid modes: It processes the available classes to generate the documentation. Read manual documentation from some JSON/XML/TEXT file to add to the generated documentation in (1) If Enunciate does not…
Irfan Zulfiqar
  • 2,029
  • 5
  • 16
  • 21
2
votes
1 answer

Enunciate http error 404

I tried to setup a simple project with spring and enunciate+jax-ws/jax-rs annotation, but I didn't get it work. I used some great tutorial for the enunciate integration tutorial Enunciate create the api-page like in the tutorial, but I get this…
user316236
  • 21
  • 3
2
votes
1 answer

org.codehaus.enunciate recent version

i am completly lost after 2 hours of trying to find a solution. For my project I need enunciate (http://enunciate.codehaus.org/) to generate a documentation for the application'S RESTFul api. Using the 1.28 version of the maven-enunciate-plugin…
skombijohn
  • 375
  • 1
  • 5
  • 17
2
votes
1 answer

Enunciate with SpringMVC Annotation-based configuration

I am trying to use Enunciate to generate static documentation for my REST API that is written in Java using Spring MVC 3.2. The Enunciate website claims that it has Spring support by using a specific plugin here :…
user947871
  • 339
  • 6
  • 17
2
votes
1 answer

Using Enanciate to document a Spring MVC REST api

I have a Spring 3 application that I am trying to generate robust api documention against. I have tried a few different projects and am seeing if enunicate(http://enunciate.codehaus.org) will suit my needs including the ability to generate swagger…
Andrew Rutter
  • 1,257
  • 2
  • 18
  • 34
1
2
3
…
9 10