Alternatives to jsdoc logo

Alternatives to jsdoc

ESDoc, Postman, Swagger UI, Apiary, and ReadMe.io are the most popular alternatives and competitors to jsdoc.
62
53
+ 1
0

What is jsdoc and what are its top alternatives?

JSDoc 3 is an API documentation generator for JavaScript, similar to JavaDoc or PHPDoc. You add documentation comments directly to your source code, right along side the code itself. The JSDoc Tool will scan your source code, and generate a complete HTML documentation website for you.
jsdoc is a tool in the Documentation as a Service & Tools category of a tech stack.

jsdoc alternatives & related posts

ESDoc logo

ESDoc

3
3
0
3
3
+ 1
0
Used to generate the documentation of JavaScript projects
    Be the first to leave a pro
    ESDoc logo
    ESDoc
    VS
    jsdoc logo
    jsdoc

    related Postman posts

    Noah Zoschke
    Noah Zoschke
    Engineering Manager at Segment · | 28 upvotes · 174.9K views
    atSegmentSegment
    Swagger UI
    Swagger UI
    ReadMe.io
    ReadMe.io
    Markdown
    Markdown
    Postman
    Postman
    #Documentation
    #Api
    #QA

    We just launched the Segment Config API (try it out for yourself here) — a set of public REST APIs that enable you to manage your Segment configuration. A public API is only as good as its #documentation. For the API reference doc we are using Postman.

    Postman is an “API development environment”. You download the desktop app, and build API requests by URL and payload. Over time you can build up a set of requests and organize them into a “Postman Collection”. You can generalize a collection with “collection variables”. This allows you to parameterize things like username, password and workspace_name so a user can fill their own values in before making an API call. This makes it possible to use Postman for one-off API tasks instead of writing code.

    Then you can add Markdown content to the entire collection, a folder of related methods, and/or every API method to explain how the APIs work. You can publish a collection and easily share it with a URL.

    This turns Postman from a personal #API utility to full-blown public interactive API documentation. The result is a great looking web page with all the API calls, docs and sample requests and responses in one place. Check out the results here.

    Postman’s powers don’t end here. You can automate Postman with “test scripts” and have it periodically run a collection scripts as “monitors”. We now have #QA around all the APIs in public docs to make sure they are always correct

    Along the way we tried other techniques for documenting APIs like ReadMe.io or Swagger UI. These required a lot of effort to customize.

    Writing and maintaining a Postman collection takes some work, but the resulting documentation site, interactivity and API testing tools are well worth it.

    See more
    Nicholas Rogoff
    Nicholas Rogoff
    at Avanade UK Ltd. · | 7 upvotes · 78.2K views
    atNHS Digital (NHS.UK)NHS Digital (NHS.UK)
    Visual Studio
    Visual Studio
    Visual Studio Code
    Visual Studio Code
    Newman
    Newman
    Postman
    Postman
    Azure DevOps
    Azure DevOps
    Git
    Git
    jQuery
    jQuery
    JavaScript
    JavaScript
    Microsoft SQL Server
    Microsoft SQL Server
    C#
    C#
    .NET Core
    .NET Core

    Secure Membership Web API backed by SQL Server. This is the backing API to store additional profile and complex membership metadata outside of an Azure AD B2C provider. The front-end using the Azure AD B2C to allow 3rd party trusted identity providers to authenticate. This API provides a way to add and manage more complex permission structures than can easily be maintained in Azure AD.

    We have .Net developers and an Azure infrastructure environment using server-less functions, logic apps and SaaS where ever possible. For this service I opted to keep it as a classic WebAPI project and deployed to AppService.

    • Trusted Authentication Provider: @AzureActiveDirectoryB2C
    • Frameworks: .NET Core
    • Language: C# , Microsoft SQL Server , JavaScript
    • IDEs: Visual Studio Code , Visual Studio
    • Libraries: jQuery @EntityFramework, @AutoMapper, @FeatureToggle , @Swashbuckle
    • Database: @SqlAzure
    • Source Control: Git
    • Build and Release Pipelines: Azure DevOps
    • Test tools: Postman , Newman
    • Test framework: @nUnit, @moq
    • Infrastructure: @AzureAppService, @AzureAPIManagement
    See more
    Swagger UI logo

    Swagger UI

    920
    524
    135
    920
    524
    + 1
    135
    A Collection of HTML, Javascript, and CSS assets that dynamically generate beautiful documentation
    Swagger UI logo
    Swagger UI
    VS
    jsdoc logo
    jsdoc

    related Swagger UI posts

    Noah Zoschke
    Noah Zoschke
    Engineering Manager at Segment · | 28 upvotes · 174.9K views
    atSegmentSegment
    Swagger UI
    Swagger UI
    ReadMe.io
    ReadMe.io
    Markdown
    Markdown
    Postman
    Postman
    #Documentation
    #Api
    #QA

    We just launched the Segment Config API (try it out for yourself here) — a set of public REST APIs that enable you to manage your Segment configuration. A public API is only as good as its #documentation. For the API reference doc we are using Postman.

    Postman is an “API development environment”. You download the desktop app, and build API requests by URL and payload. Over time you can build up a set of requests and organize them into a “Postman Collection”. You can generalize a collection with “collection variables”. This allows you to parameterize things like username, password and workspace_name so a user can fill their own values in before making an API call. This makes it possible to use Postman for one-off API tasks instead of writing code.

    Then you can add Markdown content to the entire collection, a folder of related methods, and/or every API method to explain how the APIs work. You can publish a collection and easily share it with a URL.

    This turns Postman from a personal #API utility to full-blown public interactive API documentation. The result is a great looking web page with all the API calls, docs and sample requests and responses in one place. Check out the results here.

    Postman’s powers don’t end here. You can automate Postman with “test scripts” and have it periodically run a collection scripts as “monitors”. We now have #QA around all the APIs in public docs to make sure they are always correct

    Along the way we tried other techniques for documenting APIs like ReadMe.io or Swagger UI. These required a lot of effort to customize.

    Writing and maintaining a Postman collection takes some work, but the resulting documentation site, interactivity and API testing tools are well worth it.

    See more
    Tim Nolet
    Tim Nolet
    Founder, Engineer & Dishwasher at Checkly · | 7 upvotes · 46K views
    atChecklyHQChecklyHQ
    Slate
    Slate
    Swagger UI
    Swagger UI
    Vue.js
    Vue.js
    hapi
    hapi
    Node.js
    Node.js
    JavaScript
    JavaScript

    JavaScript Node.js hapi Vue.js Swagger UI Slate

    Two weeks ago we released the public API for Checkly. We already had an API that was serving our frontend Vue.js app. We decided to create an new set of API endpoints and not reuse the already existing one. The blog post linked below details what parts we needed to refactor, what parts we added and how we handled generating API documentation. More specifically, the post dives into:

    • Refactoring the existing Hapi.js based API
    • API key based authentication
    • Refactoring models with Objection.js
    • Validating plan limits
    • Generating Swagger & Slate based documentation
    See more

    related ReadMe.io posts

    Noah Zoschke
    Noah Zoschke
    Engineering Manager at Segment · | 28 upvotes · 174.9K views
    atSegmentSegment
    Swagger UI
    Swagger UI
    ReadMe.io
    ReadMe.io
    Markdown
    Markdown
    Postman
    Postman
    #Documentation
    #Api
    #QA

    We just launched the Segment Config API (try it out for yourself here) — a set of public REST APIs that enable you to manage your Segment configuration. A public API is only as good as its #documentation. For the API reference doc we are using Postman.

    Postman is an “API development environment”. You download the desktop app, and build API requests by URL and payload. Over time you can build up a set of requests and organize them into a “Postman Collection”. You can generalize a collection with “collection variables”. This allows you to parameterize things like username, password and workspace_name so a user can fill their own values in before making an API call. This makes it possible to use Postman for one-off API tasks instead of writing code.

    Then you can add Markdown content to the entire collection, a folder of related methods, and/or every API method to explain how the APIs work. You can publish a collection and easily share it with a URL.

    This turns Postman from a personal #API utility to full-blown public interactive API documentation. The result is a great looking web page with all the API calls, docs and sample requests and responses in one place. Check out the results here.

    Postman’s powers don’t end here. You can automate Postman with “test scripts” and have it periodically run a collection scripts as “monitors”. We now have #QA around all the APIs in public docs to make sure they are always correct

    Along the way we tried other techniques for documenting APIs like ReadMe.io or Swagger UI. These required a lot of effort to customize.

    Writing and maintaining a Postman collection takes some work, but the resulting documentation site, interactivity and API testing tools are well worth it.

    See more
    Todd Gardner
    Todd Gardner
    President at TrackJS · | 4 upvotes · 77.5K views
    atTrackJSTrackJS
    Gatsby
    Gatsby
    Read the Docs
    Read the Docs
    ReadMe.io
    ReadMe.io
    GitHub Pages
    GitHub Pages
    Jekyll
    Jekyll

    We recently needed to rebuild our documentation site, currently built using Jekyll hosted on GitHub Pages. We wanted to update the content and refresh the style to make it easier to find answers.

    We considered hosted services that could accept our markdown content, like ReadMe.io and Read the Docs, however both seemed expensive for essentially hosting the same platform we already had for free.

    I also looked at the Gatsby Static Site generator to modernize Jekyll. I don't think this is a fit, as our documentation is relatively simple and relies heavily on Markdown. Jekyll excels at Markdown, while Gatsby seemed to struggle with it.

    We chose to stick with the current platform and just refresh our template and style with some add-on JavaScript.

    See more
    Read the Docs logo

    Read the Docs

    47
    56
    16
    47
    56
    + 1
    16
    Create, host, and browse documentation
    Read the Docs logo
    Read the Docs
    VS
    jsdoc logo
    jsdoc

    related Read the Docs posts

    Todd Gardner
    Todd Gardner
    President at TrackJS · | 4 upvotes · 77.5K views
    atTrackJSTrackJS
    Gatsby
    Gatsby
    Read the Docs
    Read the Docs
    ReadMe.io
    ReadMe.io
    GitHub Pages
    GitHub Pages
    Jekyll
    Jekyll

    We recently needed to rebuild our documentation site, currently built using Jekyll hosted on GitHub Pages. We wanted to update the content and refresh the style to make it easier to find answers.

    We considered hosted services that could accept our markdown content, like ReadMe.io and Read the Docs, however both seemed expensive for essentially hosting the same platform we already had for free.

    I also looked at the Gatsby Static Site generator to modernize Jekyll. I don't think this is a fit, as our documentation is relatively simple and relies heavily on Markdown. Jekyll excels at Markdown, while Gatsby seemed to struggle with it.

    We chose to stick with the current platform and just refresh our template and style with some add-on JavaScript.

    See more
    Gitbook logo

    Gitbook

    47
    19
    0
    47
    19
    + 1
    0
    Document Everything! For you, your users and your team
      Be the first to leave a pro
      Gitbook logo
      Gitbook
      VS
      jsdoc logo
      jsdoc
      Docusaurus logo

      Docusaurus

      32
      113
      3
      32
      113
      + 1
      3
      Easy to maintain open source documentation websites
      Docusaurus logo
      Docusaurus
      VS
      jsdoc logo
      jsdoc
      Slate logo

      Slate

      24
      52
      7
      24
      52
      + 1
      7
      Beautiful static documentation for your API, inspired by Stripe's and Paypal's API docs
      Slate logo
      Slate
      VS
      jsdoc logo
      jsdoc

      related Slate posts

      Tim Nolet
      Tim Nolet
      Founder, Engineer & Dishwasher at Checkly · | 7 upvotes · 46K views
      atChecklyHQChecklyHQ
      Slate
      Slate
      Swagger UI
      Swagger UI
      Vue.js
      Vue.js
      hapi
      hapi
      Node.js
      Node.js
      JavaScript
      JavaScript

      JavaScript Node.js hapi Vue.js Swagger UI Slate

      Two weeks ago we released the public API for Checkly. We already had an API that was serving our frontend Vue.js app. We decided to create an new set of API endpoints and not reuse the already existing one. The blog post linked below details what parts we needed to refactor, what parts we added and how we handled generating API documentation. More specifically, the post dives into:

      • Refactoring the existing Hapi.js based API
      • API key based authentication
      • Refactoring models with Objection.js
      • Validating plan limits
      • Generating Swagger & Slate based documentation
      See more
      Ardoq logo

      Ardoq

      10
      14
      4
      10
      14
      + 1
      4
      SaaS Platform focusing on automating and visualizing your documentation.
      Ardoq logo
      Ardoq
      VS
      jsdoc logo
      jsdoc
      Wiki.js logo

      Wiki.js

      5
      1
      0
      5
      1
      + 1
      0
      A wiki engine running on Node.js and written in JavaScript
        Be the first to leave a pro
        Wiki.js logo
        Wiki.js
        VS
        jsdoc logo
        jsdoc
        MireDot logo

        MireDot

        5
        5
        14
        5
        5
        + 1
        14
        Generate your Java REST API Documentation in 5 Minutes
        MireDot logo
        MireDot
        VS
        jsdoc logo
        jsdoc
        Docsify logo

        Docsify

        4
        11
        0
        4
        11
        + 1
        0
        A documentation site generator without the static html files
          Be the first to leave a pro
          Docsify logo
          Docsify
          VS
          jsdoc logo
          jsdoc
          Dimer logo

          Dimer

          3
          26
          0
          3
          26
          + 1
          0
          Dimer generates a clean and beautiful documentation website from Markdown.
            Be the first to leave a pro
            Dimer logo
            Dimer
            VS
            jsdoc logo
            jsdoc
            Airstory logo

            Airstory

            2
            1
            0
            2
            1
            + 1
            0
            A writing software with upgrade options for businesses that have advanced needs, like personal support
              Be the first to leave a pro
              Airstory logo
              Airstory
              VS
              jsdoc logo
              jsdoc
              Woodpecker logo

              Woodpecker

              1
              2
              0
              1
              2
              + 1
              0
              Automatically converts your documents into standardized smart-templates
                Be the first to leave a pro
                Woodpecker logo
                Woodpecker
                VS
                jsdoc logo
                jsdoc
                zeroheight logo

                zeroheight

                1
                3
                0
                1
                3
                + 1
                0
                UX design docs that stay up-to-date
                  Be the first to leave a pro
                  zeroheight logo
                  zeroheight
                  VS
                  jsdoc logo
                  jsdoc