{"id":18788606,"url":"https://github.com/albertofdzm/express-list-endpoints","last_synced_at":"2025-05-15T09:04:27.709Z","repository":{"id":3538203,"uuid":"49889904","full_name":"AlbertoFdzM/express-list-endpoints","owner":"AlbertoFdzM","description":"A express package to list all registered endpoints and its verbs","archived":false,"fork":false,"pushed_at":"2025-02-18T00:37:12.000Z","size":517,"stargazers_count":173,"open_issues_count":8,"forks_count":31,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-02T05:47:03.815Z","etag":null,"topics":["endpoints","express","expressjs","nodejs","routes"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AlbertoFdzM.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-01-18T16:40:57.000Z","updated_at":"2025-03-17T07:55:48.000Z","dependencies_parsed_at":"2024-06-18T12:39:03.156Z","dependency_job_id":"7d90c9c8-97d8-4f8f-be15-b051fe3097e5","html_url":"https://github.com/AlbertoFdzM/express-list-endpoints","commit_stats":{"total_commits":170,"total_committers":9,"mean_commits":18.88888888888889,"dds":0.3941176470588236,"last_synced_commit":"6661d7bc5aa2a84d30033fd211b4f3c6e2c7c9e5"},"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlbertoFdzM%2Fexpress-list-endpoints","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlbertoFdzM%2Fexpress-list-endpoints/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlbertoFdzM%2Fexpress-list-endpoints/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AlbertoFdzM%2Fexpress-list-endpoints/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AlbertoFdzM","download_url":"https://codeload.github.com/AlbertoFdzM/express-list-endpoints/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247589822,"owners_count":20963025,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["endpoints","express","expressjs","nodejs","routes"],"created_at":"2024-11-07T21:05:23.360Z","updated_at":"2025-04-07T04:07:45.875Z","avatar_url":"https://github.com/AlbertoFdzM.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Express List Endpoints\n\n\u003e [!IMPORTANT]\n\u003e This package only works for express 4.\\* versions. It's not compatible with express 5 yet.\n\n[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/AlbertoFdzM/express-list-endpoints/ci.yml?branch=main\u0026logo=github)](https://github.com/AlbertoFdzM/express-list-endpoints/actions/workflows/ci.yml?query=branch%3Amain) [![Codecov Coverage Report](https://img.shields.io/codecov/c/github/AlbertoFdzM/express-list-endpoints/main)](https://codecov.io/github/AlbertoFdzM/express-list-endpoints?branch=main) [![Code Climate Maintainability Report](https://img.shields.io/codeclimate/maintainability/AlbertoFdzM/express-list-endpoints)](https://codeclimate.com/github/AlbertoFdzM/express-list-endpoints/maintainability) [![NPM Downloads](https://img.shields.io/npm/dm/express-list-endpoints)\n](https://www.npmjs.com/package/express-list-endpoints) [![NPM License](https://img.shields.io/npm/l/express-list-endpoints)](https://www.npmjs.com/package/express-list-endpoints)\n\n[![NPM Package Page](https://img.shields.io/badge/express--list--endpoints-gray?label=npm\u0026labelColor=c21104)](https://www.npmjs.com/package/express-list-endpoints)\n\nExpress endpoint parser to retrieve a list of the passed router with the set verbs.\n\n## Examples of use\n\n```javascript\nconst express = require(\"express\");\nconst expressListEndpoints = require(\"express-list-endpoints\");\n\nlet app = express();\n\napp\n  .route(\"/\")\n  .all(function namedMiddleware(req, res) {\n    // Handle request\n  })\n  .get(function (req, res) {\n    // Handle request\n  })\n  .post(function (req, res) {\n    // Handle request\n  });\n\napp.route(\"/about\").get(function (req, res) {\n  // Handle request\n});\n\nconst endpoints = expressListEndpoints(app);\n\nconsole.log(endpoints);\n\n/* It omits 'all' handlers.\n[\n  {\n    path: '/',\n    methods: [ 'GET', 'POST' ],\n    middlewares: [ 'namedMiddleware', 'anonymous', 'anonymous' ]\n  },\n  {\n    path: '/about',\n    methods: [ 'GET' ],\n    middlewares: [ 'anonymous' ]\n  }\n]\n*/\n```\n\n```typescript\nimport express from \"express\";\nimport expressListEndpoints from \"express-list-endpoints\";\n\nlet app = express();\n\napp\n  .route(\"/\")\n  .all(function namedMiddleware(req, res) {\n    // Handle request\n  })\n  .get(function (req, res) {\n    // Handle request\n  })\n  .post(function (req, res) {\n    // Handle request\n  });\n\napp.route(\"/about\").get(function (req, res) {\n  // Handle request\n});\n\nconst endpoints = expressListEndpoints(app);\n\nconsole.log(endpoints);\n```\n\n## Arguments\n\n### `app` - Express `app` or `router` instance\n\nYour router instance (`router`) or your app instance (`app`).\n\n_**Note:** Pay attention that before call this script the router or app must have the endpoints registered due to detect them._\n\n## Contributing to express-list-endpoints\n\n### Development\n\nRunning test:\n\n```shell\nnpm test\n```\n\n## License\n\nExpress List Endpoints is [MIT licensed](./LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falbertofdzm%2Fexpress-list-endpoints","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falbertofdzm%2Fexpress-list-endpoints","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falbertofdzm%2Fexpress-list-endpoints/lists"}