Need advice about which tool to choose?Ask the StackShare community!

Docusaurus

130
339
+ 1
33
Read the Docs

64
254
+ 1
22
Swagger UI

1.7K
1.6K
+ 1
204
Advice on Docusaurus, Read the Docs, and Swagger UI
Needs advice
on
PostmanPostmanApiaryApiary
and
Swagger UISwagger UI

From a StackShare Community member: "I just started working for a start-up and we are in desperate need of better documentation for our API. Currently our API docs is in a README.md file. We are evaluating Postman and Swagger UI. Since there are many options and I was wondering what other StackSharers would recommend?"

See more
Replies (3)
Jagdeep Singh
Tech Lead at ucreate.it · | 8 upvotes · 267K views

I use Postman because of the ease of team-management, using workspaces and teams, runner, collections, environment variables, test-scripts (post execution), variable management (pre and post execution), folders (inside collections, for better management of APIs), newman, easy-ci-integration (and probably a few more things that I am not able to recall right now).

See more

I use Swagger UI because it's an easy tool for end-consumers to visualize and test our APIs. It focuses on that ! And it's directly embedded and delivered with the APIs. Postman's built-in tools aren't bad, but their main focus isn't the documentation and also, they are hosted outside the project.

See more
Sadik Ay
Recommends
PostmanPostman

I recommend Postman because it's easy to use with history option. Also, it has very great features like runner, collections, test scripts runners, defining environment variables and simple exporting and importing data.

See more
Get Advice from developers at your company using StackShare Enterprise. Sign up for StackShare Enterprise.
Learn More
Pros of Docusaurus
Pros of Read the Docs
Pros of Swagger UI
  • 7
    Open Source
  • 7
    Self Hosted
  • 3
    Easy customization
  • 3
    Jamstack
  • 3
    MDX
  • 3
    React
  • 3
    Free to use
  • 2
    I18n
  • 2
    Versioning
  • 13
    GitHub integration
  • 7
    Free for public repos
  • 2
    Automated Builds
  • 47
    Open Source
  • 34
    Can execute api calls from the documentation
  • 29
    Free to use
  • 19
    Customizable
  • 14
    Easy to implement in .Net
  • 13
    Mature, clean spec
  • 11
    API Visualization
  • 9
    Coverage
  • 6
    Easy to use
  • 6
    Scaffolding
  • 5
    Vibrant and active community
  • 4
    Elegant
  • 3
    Adopted by tm forum api
  • 2
    Clear for React
  • 1
    Can deploy API to AWS API Gateway and AWS Lambda
  • 1
    Api

Sign up to add or upvote prosMake informed product decisions

Cons of Docusaurus
Cons of Read the Docs
Cons of Swagger UI
    Be the first to leave a con
      Be the first to leave a con
      • 3
        Need to learn YAML and RAML
      • 2
        Documentation doesn't look that good
      • 1
        Doesn't generate code snippets in different languages
      • 1
        You don’t actually get in-line error highlighting
      • 1
        Does not support hypermedia

      Sign up to add or upvote consMake informed product decisions

      - No public GitHub repository available -

      What is Docusaurus?

      Docusaurus is a project for easily building, deploying, and maintaining open source project websites.

      What is Read the Docs?

      It hosts documentation, making it fully searchable and easy to find. You can import your docs using any major version control system, including Mercurial, Git, Subversion, and Bazaar.

      What is Swagger UI?

      Swagger UI is a dependency-free collection of HTML, Javascript, and CSS assets that dynamically generate beautiful documentation and sandbox from a Swagger-compliant API

      Need advice about which tool to choose?Ask the StackShare community!

      What companies use Docusaurus?
      What companies use Read the Docs?
      What companies use Swagger UI?

      Sign up to get full access to all the companiesMake informed product decisions

      What tools integrate with Docusaurus?
      What tools integrate with Read the Docs?
      What tools integrate with Swagger UI?

      Sign up to get full access to all the tool integrationsMake informed product decisions

      What are some alternatives to Docusaurus, Read the Docs, and Swagger UI?
      Confluence
      Capture the knowledge that's too often lost in email inboxes and shared network drives in Confluence instead – where it's easy to find, use, and update.
      Gitbook
      It is a modern documentation platform where teams can document everything from products, to APIs and internal knowledge-bases. It is a place to think and track ideas for you & your team.
      MkDocs
      It builds completely static HTML sites that you can host on GitHub pages, Amazon S3, or anywhere else you choose. There's a stack of good looking themes available. The built-in dev-server allows you to preview your documentation as you're writing it. It will even auto-reload and refresh your browser whenever you save your changes.
      VuePress
      A minimalistic static site generator with a Vue-powered theming system, and a default theme optimized for writing technical documentation. It was created to support the documentation needs of Vue's own sub projects.
      Hugo
      Hugo is a static site generator written in Go. It is optimized for speed, easy use and configurability. Hugo takes a directory with content and templates and renders them into a full html website. Hugo makes use of markdown files with front matter for meta data.
      See all alternatives