文件名称：restdocs-api-spec:向Spring REST Docs添加API规范支持
文件大小：275KB
文件格式：ZIP
更新时间：2024-05-20 18:00:05
spring openapi openapi-documentation rest-api-documentation spring-rest-docs
Spring REST Docs API规范集成 这是一个扩展，将API规范作为输出格式添加到 。 目前支持： json和yaml json和yaml 我们计划增加对以下方面的支持： 请注意，此扩展是针对基于JSON的API开发的。 我们不希望此扩展为非JSON请求或响应主体建立可用的API规范。 动机 是一个非常好的工具，可以为您的RESTful服务生成准确且易读的文档。 我们特别喜欢它的测试驱动方法，这是我们选择它的主要原因。 它为AsciiDoc和Markdown提供支持。 这对于生成简单的基于HTML的文档非常有用。 但是这两种都是标记语言，因此，除了静态生成HTML外，很难再进一步了。 像OpenAPI这样的API规范更加灵活。 借助OpenAPI，您可以获得API的机器可读描述。 周围有一个丰富的生态系统，其中包含以下工具： 生成APIHTML表示 产生一个互