RE: [docbook-apps] REST API description

From
Jan Tosovsky <>
Date
2017-12-07T20:45:58+00:00
ID
[email protected]
Thread
RE: [docbook-apps] REST API description
On 2017-12-07 David Cramer wrote:
> On 2017-12-05 Jan Tosovsky wrote:
> > Is there any recommended DocBook tag set for describing REST API?
>
> I don't think DocBook is the right vocabulary for modeling a REST API.
> There's an XML schema, WADL (Web Application Description Language) that
> is designed for that
> ...
> These days non-xml vocabularies for modeling REST apis are more popular.
> Each has its own strengths and weaknesses, depending on your needs.
> 

I've ended up in very similar conclusion :-)

I haven't heard about WADL yet, but right now I am investigating ways how to convert Swagger's OpenAPI (subset) to my DocBook structure.

Jan