Slate vs Swagger - 哪个更好，哪个有更多选择? [英] Slate vs Swagger - Which is better and which have more options?

问题描述

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

I have to document my API's. I have to use any one of them Slate Or Swagger. I want to know which one have more options, pros and cons, which one is better.

推荐答案

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

Swagger and Slate serve two different purposes. Swagger is an attempt at a standardized way of describing a RESTful API (similar, for example, to ApiBlueprint)

Swagger 是一种基于 JSON 的 API 定义格式，允许描述 REST API.

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

~ 来自 Swagger 的 API 设计工具

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

Slate, on the other hand is a pretty theme for writing nice API docs.

1. 两者并不相互排斥
2. 理想情况下，应该根据 Swagger API 描述生成 slate 文档

Swagger 的目标是提供一个标准，其他人可以在此基础上构建广泛的工具(例如:文档、API 浏览器、模拟服务器、代码生成、测试实用程序等).例如，请参阅:Swagger 工具

The goal of Swagger is to provide a standard upon which others can build extensive tooling (for example: documentation, API explorers, mock servers, code generation, testing utilities etc.). See, for example: Swagger Tooling

更多问题:一些用于招摇的 Slate 工具:

More to your question: Some Slate tooling for swagger:

• 这是一个 链接到以 Slate 为主题的招摇 UI
• 这是一个根据您的 Swagger 定义生成 Slate 文档的项目

所以这两者不是相互排斥的，而是直接提出的问题:实施 Swagger 将为您提供更多选择和更大的灵活性(以及生成 Slate 文档的能力).

So the two are not mutually exclusive, but to your direct question: Implementing Swagger will give you more options and greater flexibility (was well as the ability to also generate Slate documentation).

这篇关于Slate vs Swagger - 哪个更好，哪个有更多选择?的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！