简体   繁体   English

Swagger 定制文档

[英]Swagger custom documentation

Is there a way to generate a README.md file from swagger?有没有办法从 swagger 生成 README.md 文件? I would like to put similar details that would be found in swagger web page plus some custom comments.我想提供在 swagger web 页面中可以找到的类似细节以及一些自定义评论。

Also, is there a way to make a aggregator swagger web page?另外,有没有办法制作一个聚合器 swagger web 页面? I want to have the all swagger web pages from all micro services also in a single place.我想将来自所有微服务的所有 swagger web 页面也放在一个地方。 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?".这可以让我对我的系统有更高的了解,并且可能会做一些查询,比如“某个实体可以通过多少方式获得另一个实体?”。

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.关于 README.md 文件 - 不确定要在其中包含哪些信息,但您可以编写自己的方法,该方法将使用Swagger Parser执行此操作,以便从 Swagger 规范中获取所需信息。

Regarding aggregated swagger - you can use Swagger-aggregate for this purpose.关于聚合的 swagger - 您可以为此目的使用Swagger-aggregate

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM