CODEWITHSUNDEEP
springrestcxf
dexter
dexter

Reputation: 13583

Apache CXF: Documentation for rest APIs

We use Apache CXF along with Spring for developing a web services application. Is there any way to generate all the end-points in the application as a document just using the built-in annotations?

I am looking for something like rake routes in the Rails world ;)

Upvotes: 0

Views: 1033

Answers (1)

Christophe L
Christophe L

Reputation: 14035

CXF can automatically generate a service listing with links to WADL files, describing your web-services.

By default, if you have a REST web-service exposed at

http://host/path

going to

http://host/path/services

should give you that service listing.

To directly get the WADL document just add ?_wadl to where your REST server is mounted. All the operations and methods available on this path and its children should be documented there.

See http://cxf.apache.org/docs/jaxrs-services-description.html (section "Service listings and WADL queries" in particular).

Upvotes: 2

Related Questions