CODEWITHSUNDEEP
javaspringweb-servicesrest
Zemzela
Zemzela

Reputation: 3080

REST API Schema

I'm developing rest web services with spring mvc, and everything is stright forward, but I've faced with one problem how to expose the api schema for the consumers something like wsdl.I want to have one web page with all methods(end points e.q. request mapping) and what kind of request method(GET, POST), and expected request params type(json, xml, post params, get params).

Upvotes: 1

Views: 1043

Answers (2)

JSS
JSS

Reputation: 2201

The Web Application Description Language (WADL) is an XML vocabulary used to describe RESTful web services.

As with WSDL, a generic client can load a WADL file and be immediately equipped to access the full functionality of the corresponding web service.

Since RESTful services have simpler interfaces, WADL is not nearly as necessary to these services as WSDL is to RPC-style SOAP services.

Upvotes: 0

Joe Beuckman
Joe Beuckman

Reputation: 2296

A fantastic way to show this is with the Swagger tool. Swagger will let you create an html test harness that shows expected params, makes demo requests and shows the API responses.

Upvotes: 2

Related Questions