Discussion on: Let's Understand the Express.js framework

[Prafulla Raichurkar]

Great article, I would like to share a GitHub action which I created

Pika1998 / express-autodocs

A GitHub action which automatically generates documentation for your express APIs.

💡 Introduction

This action automatically scans for express APIs in your codebase and generates a documentation website

How to add to your workflow ❔

To add this action to your workflow simply modify your workflows main.yml file.

# This is a basic workflow to help you get started with Express AutoDocs Action
name: Express AutoDocs.
# This specifies when the action should occur
on
  push
    branches: [master]

jobs:
  generate_docs_job:
    runs-on: ubuntu-latest
    name: Generating Docs
    steps:
      # this step checks out the master branch of your repo using checkout action.
      - name: Checks out the repository
        id: checksout-repository
        uses: actions/checkout@v2
        with:
          repository: ""
      # this step generates the docs
      - name: Generating Docs.
        id: reading-file
        uses: Pika1998/express-autodocs@v0.0.1
      # Use the output from the `hello` step
      - name: Get the output time
        run

…

View on GitHub

This action scans for express APIs and generates automatic documentation using them, I feel it would add more value to this article :)

[mikitashah]

Sure, if it helps other developers with the combined documentation, then I have no issues.