documentation - Slate vs Swagger-哪个更好，哪个有更多选择？

Question

Closed. This question does not meet Stack Overflow guidelines。它当前不接受答案。












想改善这个问题吗？更新问题，以便将其作为 on-topic用于堆栈溢出。

2年前关闭。



Improve this question




我必须记录我的API。我必须使用其中任何一个 Slate或 Swagger。我想知道哪个有更多的选择和利弊，哪个更好。

最佳答案

Swagger和Slate有两个不同的用途。 Swagger是一种尝试以标准方式描述RESTful API(例如，类似于ApiBlueprint)

Swagger is a JSON based API definition format, which allows for the description of REST APIs.

〜 API Design Tooling From Swagger

另一方面，Slate是编写漂亮的API文档的漂亮主题。

两者不是互斥的

理想情况下，应该从Swagger API描述

生成您的slate文档

Swagger的目标是提供一个标准，其他人可以在此标准上构建广泛的工具(例如:文档，API资源管理器，模拟服务器，代码生成，测试实用程序等)。例如，参见: Swagger Tooling

您的问题还有更多:一些Slate的 Swagger 工具:

这是一个link to a Slate themed swagger UI

这是一个项目generates Slate docs based on your Swagger definition

因此，这两者并不是互斥的，而是您的直接问题:实现Swagger将为您提供更多选择和更大的灵活性(以及生成Slate文档的能力)。

关于documentation - Slate vs Swagger-哪个更好，哪个有更多选择？ ，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/29469938/

上一篇：selenium-webdriver - 不允许的复合类名称错误Webdriver

下一篇：batch-file - 批处理脚本可在一分钟内查找和替换文本文件中的字符串，文件最大为 12 MB

相关文章：

APIDOC - 删除示例请求

node.js - 如何在 Express.js 上托管 jsdoc/apidoc

eclipse - 在 Eclipse 中切换 Javadoc block 注释

Java文档

ruby-on-rails - Rails Guides 离线文档

Swagger 3.0.0 代码生成失败 java.lang.RuntimeException : missing swagger input or config

java - REST API - Swagger + Java + Jersey 错误的列表路径和额外的 api

c++ - 我如何记录以便文档适用于类成员而不是匿名类型？

python - 如何记录分配的而不是定义的功能？

asp.net-web-api - 带有 swashbuckle api 文档的 http 基本身份验证

Answer 1

Swagger和Slate有两个不同的用途。 Swagger是一种尝试以标准方式描述RESTful API(例如，类似于ApiBlueprint)

Swagger is a JSON based API definition format, which allows for the description of REST APIs.

〜 API Design Tooling From Swagger

另一方面，Slate是编写漂亮的API文档的漂亮主题。

两者不是互斥的

理想情况下，应该从Swagger API描述

生成您的slate文档

Swagger的目标是提供一个标准，其他人可以在此标准上构建广泛的工具(例如:文档，API资源管理器，模拟服务器，代码生成，测试实用程序等)。例如，参见: Swagger Tooling

您的问题还有更多:一些Slate的 Swagger 工具:

这是一个link to a Slate themed swagger UI

这是一个项目generates Slate docs based on your Swagger definition

因此，这两者并不是互斥的，而是您的直接问题:实现Swagger将为您提供更多选择和更大的灵活性(以及生成Slate文档的能力)。