OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.


Help: OASIS Mailing Lists Help | MarkMail Help

docbook-apps message

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]

Subject: Re: [docbook-apps] REST API description

I'm using NPM Bootprint (https://www.npmjs.com/package/bootprint) to
convert OpenAPI YAML definititions to HTML. Then I use Jsoup
(https://jsoup.org/) to convert the resulting HTML to XHTML. Then I
use XSLT to insert the XHTML API documentation into my DocBook

I'm not too happy about this Rube Goldberg system. An OpenAPI YAML to
DocBook utility would be so handy.


On Thu, Dec 7, 2017 at 3:45 PM, Jan Tosovsky <j.tosovsky@email.cz> wrote:
> 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
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: docbook-apps-unsubscribe@lists.oasis-open.org
> For additional commands, e-mail: docbook-apps-help@lists.oasis-open.org

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]