Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Slate vs Swagger - Which is better and which have more options? [closed]

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.

like image 749
Sariban D'Cl Avatar asked Apr 06 '15 10:04

Sariban D'Cl


People also ask

Is there something better than Swagger?

The best alternative is Doxygen, which is both free and Open Source. Other great apps like swagger.io are Slate API Docs Generator, ReDoc, Magidoc and Apiary.


1 Answers

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 is a JSON based API definition format, which allows for the description of REST APIs.

~ API Design Tooling From Swagger

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

  1. The two are not mutually exclusive
  2. Ideally, one should generate your slate documentation from your Swagger API description

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

More to your question: Some Slate tooling for swagger:

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

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).

like image 54
toast38coza Avatar answered Sep 30 '22 22:09

toast38coza