JSDoc VS Swagger UI

JSDoc Reviews

Swagger UI Reviews

JSDoc mentions (48)

• Eloquent JavaScript 4th edition (2024)

  I wholeheartedly agree. At most, I introduce JSDoc[1] to newer developers as standardising how parameters and whatnot are commented at least gets you better documentation and _some_ safety without adding any TS knowledge overhead. [1] https://jsdoc.app/. - Source: Hacker News / about 1 month ago

• Add typing to your Javascript code (without Typescript, kinda) ✍🏼

  The best way to do this, of course, is with JSDoc. But something I always found awkward about jsdoc is defining the object types in the same file. So, after a lot of reading, I found a way to combine JSDoc with declaration type files from Typescript. Let me give you an example:. - Source: dev.to / 2 months ago

• What is JSDoc and why you may not need typescript for your next project?

  There is a lot of specific symbols presented on the JSDOC specification that can be found here: https://jsdoc.app. - Source: dev.to / 3 months ago

• TypeScript Might Not Be Your God: Case Study of Migration from TS to JSDoc

  JSDoc is a specification for the comment format in JavaScript. This specification allows developers to describe the structure of their code, data types, function parameters, and much more using special comments. These comments can then be transformed into documentation using appropriate tools. - Source: dev.to / 3 months ago

• Adding a search feature to my app

  Working with new features, frameworks, and tools, the experience of reading documentation is a critical part of it. I have been lucky to work with projects that feature really easy to read documentation such as USWDS and Bun, but I've also had the misfortune to work with pretty terrible documentation like JSDoc. The JSDoc documentation lacks a search field which makes searching for specific items an ordeal and... - Source: dev.to / 6 months ago

Swagger UI mentions (43)

• What is API Discovery, and How to Use it to Reduce Your Attack Surface

  Configure Swagger UI or a similar tool for automated scanning and documentation of your network's APIs. Here's a basic example of how to set up a Swagger configuration file (swagger-config.yaml) for API documentation:. - Source: dev.to / about 1 month ago

• Fun with Avatars: Crafting the core engine | Part. 1

  API Documentation: FastAPI generates interactive documentation with Swagger UI and ReDoc, making exploring and understanding API endpoints effortless. - Source: dev.to / 3 months ago

• Building Fast APIs with FastAPI: A Comprehensive Guide

  Visit http://127.0.0.1:8000 in your browser or a tool like Swagger UI to explore the automatically generated API documentation. - Source: dev.to / 4 months ago

• Effortless API Documentation: Accelerating Development with FastAPI, Swagger, and ReDoc

  Swagger UI allows developers to explore and test API endpoints interactively. It displays detailed information about each endpoint, including parameters, request/response models, and example requests. - Source: dev.to / 4 months ago

• FastAPI Production Setup Guide 🏁⚡️🚀

  ℹ️ FastAPI automatically generates an OpenAPI spec from the python metadata and runs a Swagger UI for interactive documentation. - Source: dev.to / 6 months ago