Slate vs Swagger——哪个更好，哪个有更多选择？
Slate vs Swagger - Which is better and which have more options?
我必须记录我的 API。我必须使用其中任何一个 Slate Or Swagger。我想知道哪个选择多，优缺点，哪个更好。
在我看来，这些工具的用途截然不同。 Swagger 是一种描述语言，而 slate 只是用于文档。
我已经使用 swagger 创建了一个描述，从中我可以为我的 API 自动生成不同的客户端，甚至自动生成文档。
您还可以根据 swagger 规范创建 Markdown，并在 Slate 中使用这些 markdown。 [1]
关于石板：
- API 文档 Template/Framework
- 看起来不错
- 易用性
- 语法高亮
- 语言特定 – 选项卡式
- 页面搜索
- 3 列可自定义布局
- 我们可以创建 table
- 每个 blocks/methods/headings
的可滚动链接
- 警报设施 [3 种类型] – 警告、成功、通知
- http 错误代码表
- 降价语法
- 我们可以使用网站标志
- Demo
关于招摇：
- 它为我们提供了 API 访问文档内部的权限，我们可以在其中检查任何特定请求的响应。
- 它清晰地展示了 API 响应的参数和选项。
- 基于 YAML 的格式
- 不适合超媒体 API
- Swagger
没有设计工具
- 回复在 XML 或 JSON
中
- Swagger JS -- JavaScript 库通过浏览器或 nodejs
连接到支持 swagger 的 APIs
- Swagger Node Express -- node.js express 模块
的 Swagger 模块
- 它有 swagger UI 框架
- Demo
我根据python-flask制作slate-flask(https://github.com/AhnSeongHyun/slate-flask)。
特点：
配置文件(config.json) : 使用config.json基于JSON格式设置示例代码的标题、编程语言。还要设置 API 文件的路径和目录（Table 的内容）。
支持Multi-API文档：原Slate支持一个API基于Markdown格式的文档。但是 slate-flask 支持 multi-API 文档以使用 TOC(index.json).
支持文件动态变化：无需重启服务器即可反映API个文件的变化。网页刷新时，如果有变化，slate-flask重新加载API个文件。用户只专注于编写 API 文档。
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
关于您的问题的更多信息：一些用于 swagger 的 Slate 工具：
- 这是一个link to a Slate themed swagger UI
- 这是一个 generates Slate docs based on your Swagger definition
的项目
所以这两者并不相互排斥，但对于您的直接问题：实施 Swagger 将为您提供更多选择和更大的灵活性（以及生成 Slate 文档的能力）。
我必须记录我的 API。我必须使用其中任何一个 Slate Or Swagger。我想知道哪个选择多，优缺点，哪个更好。
在我看来，这些工具的用途截然不同。 Swagger 是一种描述语言，而 slate 只是用于文档。
我已经使用 swagger 创建了一个描述，从中我可以为我的 API 自动生成不同的客户端，甚至自动生成文档。
您还可以根据 swagger 规范创建 Markdown，并在 Slate 中使用这些 markdown。 [1]
关于石板：
- API 文档 Template/Framework
- 看起来不错
- 易用性
- 语法高亮
- 语言特定 – 选项卡式
- 页面搜索
- 3 列可自定义布局
- 我们可以创建 table
- 每个 blocks/methods/headings
的可滚动链接
- 警报设施 [3 种类型] – 警告、成功、通知
- http 错误代码表
- 降价语法
- 我们可以使用网站标志
- Demo
关于招摇：
- 它为我们提供了 API 访问文档内部的权限，我们可以在其中检查任何特定请求的响应。
- 它清晰地展示了 API 响应的参数和选项。
- 基于 YAML 的格式
- 不适合超媒体 API
- Swagger
没有设计工具
- 回复在 XML 或 JSON
中
- Swagger JS -- JavaScript 库通过浏览器或 nodejs
连接到支持 swagger 的 APIs
- Swagger Node Express -- node.js express 模块
的 Swagger 模块
- 它有 swagger UI 框架
- Demo
我根据python-flask制作slate-flask(https://github.com/AhnSeongHyun/slate-flask)。
特点：
配置文件(config.json) : 使用config.json基于JSON格式设置示例代码的标题、编程语言。还要设置 API 文件的路径和目录（Table 的内容）。
支持Multi-API文档：原Slate支持一个API基于Markdown格式的文档。但是 slate-flask 支持 multi-API 文档以使用 TOC(index.json).
进行高效管理和文档数量
支持文件动态变化：无需重启服务器即可反映API个文件的变化。网页刷新时，如果有变化，slate-flask重新加载API个文件。用户只专注于编写 API 文档。
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
关于您的问题的更多信息：一些用于 swagger 的 Slate 工具：
- 这是一个link to a Slate themed swagger UI
- 这是一个 generates Slate docs based on your Swagger definition 的项目
所以这两者并不相互排斥，但对于您的直接问题：实施 Swagger 将为您提供更多选择和更大的灵活性（以及生成 Slate 文档的能力）。