Join
1
4 Comments

Seeking advice on a Swagger/open-api web documentation generator

by gsempe

Hi everyone,
I just pushed online the documentation of my project API. I used spectacle to automatically generate the web interface from the open api definition https://github.com/sourcey/spectacle

spectacle is a good open source project but hacking in the code is needed to adapt almost anything but the logo.

Do you use another Swagger/open-api web documentation generator that you are happy with?

gsempe's avatargsempe
on April 2, 2020
Say something nice to gsempe…
Post Comment
  1. 2

    Evaluated Swagger, Redoc and RapiDoc. (Just listing the cons)

    • Swagger - Feature rich but not good on usability or design, seems like a half baked attempt to build a programmer's tool. May not be an ideal one to expose to your customers or sub-technical users
    • Redoc - Lacks many features, biggest one is they dont support Trying out APIs, dont show server information or security information for each operation
    • RapiDoc - Lacks localization support and works for modern browsers no support for IE-11

    Out of the 3 I found RapiDoc (https://mrin9.github.io/RapiDoc/) to be the best. It is highly theme-able and very easy to program with. builds on with latest standards in pure JavaScript WebComponent without any framework involved

    baboonmaz's avatar baboonmaz
    ·
    6 years ago
    ·
    Reply
    1. 2

      I have published the first versions with Spectacle but there is no built-in way to try the API either.
      I'm going to have a look to RapiDoc. It sounds to be the perfect fit for me.

      Thank you!

      gsempe's avatar gsempe
      ·
      6 years ago
      ·
      Reply
  2. 2

    I've had success using https://github.com/Redocly/redoc

    atresnjo's avatar atresnjo
    ·
    6 years ago
    ·
    Reply
    1. 1

      Redoc looks good. I'm going to try to generate my API documentation with it. Thank you

      gsempe's avatar gsempe
      ·
      6 years ago
      ·
      Reply