CODEWITHSUNDEEP
javaswagger
OneNoOne
OneNoOne

Reputation: 597

Swagger custom documentation

Is there a way to generate a README.md file from swagger? I would like to put similar details that would be found in swagger web page plus some custom comments.

Also, is there a way to make a aggregator swagger web page? I want to have the all swagger web pages from all micro services also in a single place. This could enable me to take higher picture notion of my system and maybe do some queries like "how many ways certain entity can get this another entity?".

Upvotes: 0

Views: 170

Answers (1)

VadymVL
VadymVL

Reputation: 5566

Regarding README.md file - not sure what information you want to include in it, but you can write your own method which will do it using Swagger Parser in order to get required information from Swagger specification.

Regarding aggregated swagger - you can use Swagger-aggregate for this purpose.

Upvotes: 1

Related Questions