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.

〜 API设计工具从Swagger

Slate是编写漂亮的API文档的漂亮主题。

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

1. 两者不是互斥的


2. 理想情况下，应该从您的Swagger API描述中生成板岩文档

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

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为主题的摇摇欲坠的用户界面


• 这里是根据您的Swagger定义生成Slate文档

• Here is a link to a Slate themed swagger UI
• Here is a project that generates Slate docs based on your Swagger definition

唯一的，但直接的问题是：实施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屋！